Ad Account Report
hyros_get_ad_account_reportRead-only
Get aggregated advertising performance metrics grouped by ad account. Analyze revenue, cost, ROAS, and other key metrics across your campaigns and ads.
Instructions
Get attribution metrics grouped by ad account. Provide the ad account ID(s) to get aggregated performance across all campaigns/ads in those accounts.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | Comma-separated ad account IDs to report on (required) | |
| fields | Yes | Comma-separated metrics (required). Options: revenue,cost,sales,leads,roas,roi,profit,clicks,impressions,ctr,cost_per_lead,cost_per_sale,name | |
| pageId | No | Pagination page ID | |
| endDate | Yes | Report end date in ISO 8601 format (required) | |
| currency | No | Currency for monetary values | |
| pageSize | No | Results per page (max 250) | |
| startDate | Yes | Report start date in ISO 8601 format (required) | |
| attributionModel | Yes | Attribution model to use | |
| dayOfAttribution | No | If true, filters by click date instead of sale date | |
| forecastingOption | No | Forecasting basis for LTV/forecast fields | |
| scientificDaysRange | No | Day range (1-30) for first ad attribution, used with the scientific model | |
| sourceConfiguration | No | Which sources to include in attribution | |
| ignoreRecurringSales | No | Exclude recurring sales from the report | |
| dateTimeGroupingOption | No | Group results by time period instead of a single aggregate row (default: ad_account). With day, a 30-day window returns 30 rows whose costs sum to the aggregate total. | |
| newCustomerConfiguration | No | Customer cohort to include | |
| windowAttributionDaysRange | No | Attribution window in days (0-365) |