Actions60
- Ad Actions
- Ad Account Actions
- Attribution Actions
- Call Actions
- Cart Actions
- Click Actions
- Conversion Path Actions
- Custom Cost Actions
- Domain Actions
- Keyword Actions
- Lead Actions
- Order Actions
- Product Actions
- Request Status Actions
- Sale Actions
- Source Actions
- Stage Actions
- Subscription Actions
- Tag Actions
- Tracking Script Actions
- URL Rule Actions
- User Info Actions
- Webhook Subscription Actions
Attribution → Get ROAS
AI-generatedSummary
Fetches Hyros attribution ROAS for a specified entity over a date range, using click date or sale date to filter the range.
Inputs
- Start Date (required) — Start of the attribution date range in ISO 8601 format.
- End Date (required) — End of the attribution date range in ISO 8601 format.
- Entity ID (required) — ID of the ad platform entity to report on.
- Level (required) — Entity granularity: Account, Ad, Campaign, or Source Link. Campaign is available on Meta, Google, and LinkedIn; Source Link corresponds to an ad set on Meta or an ad group elsewhere. Defaults to Source Link.
- Basis — Date used to filter the range: Click Date credits clicks made within the range, even if sales arrive later; Sale Date counts revenue collected within the range. Defaults to Click Date.
Output shape
A single ROAS report object, or no result when the entity has no row for the requested range.
The implementation reads the start date, end date, entity ID, level, and basis to request the report. The response is returned as provided by the API.
Examples
Example 1: Retrieve ROAS for a campaign using sale date
Provide the campaign ID, select Campaign, set the ISO 8601 start and end dates, and choose Sale Date as the basis.