Get Performance Metrics
performance_metricsRead paginated performance metrics for ads, audiences, creatives, offers, target groups, or keywords. The endpoint argument selects the report and dates use ISO 8601. Returns one page of metrics and available pagination metadata, with at most 100 rows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Set of IDs to filter by | |
| page | No | Page number to retrieve (0-based indexing) | |
| size | No | Results per page from 1 to 100; default 100. Use successive zero-based page values and response pagination metadata for more results. | |
| sort | No | Sorting criteria (e.g., 'spent,desc', 'cpl,asc', 'experimentId,spent,desc') | |
| tags | No | Set of tag IDs to filter by | |
| goals | No | Filter by campaign goals | |
| adName | No | Filter by specific ad name | |
| maxCpl | No | Maximum cost per lead threshold | |
| minCpl | No | Minimum cost per lead threshold | |
| endDate | No | endDate in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ), e.g., `startDate=2025-06-12T14:30:00.123Z`). | |
| keyword | No | Filter by specific keyword | |
| channels | No | Filter by marketing channels | |
| endpoint | No | Specific endpoint to query. If not specified, will be auto-determined from query context. Use 'customAudience/group' for target groups. | |
| maxLeads | No | Maximum number of leads threshold | |
| maxSpend | No | Maximum spend threshold | |
| minLeads | No | Minimum number of leads threshold | |
| minSpend | No | Minimum spend threshold | |
| adFormats | No | Filter by ad format types. Applied to ads endpoint automatically. | |
| offerName | No | Filter by specific offer name | |
| startDate | No | startDate in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ), e.g., `startDate=2025-06-12T14:30:00.123Z`). | |
| offerTypes | No | Filter by offer types. LG=Lead Gen forms, LP=Landing Pages | |
| oppsEndDate | No | End date for opportunities data in ISO 8601 format | |
| campaignName | No | Filter by specific campaign name | |
| creativeName | No | Filter by specific creative name | |
| visibilities | No | Filter by visibility status. The platform knows only VISIBLE (live) and ARCHIVED; there is no HIDDEN value and sending one is rejected with a 400. | |
| accountTagIds | No | Set of account tag IDs to filter by | |
| audienceTypes | No | Filter by audience types | |
| experimentIds | No | Set of experiment IDs to filter by | |
| oppsStartDate | No | Start date for opportunities data in ISO 8601 format | |
| showWithSpend | No | Show only experiments/ingredients with spend data | |
| customFieldIds | No | Custom field IDs to include | |
| experimentList | No | Experiment list filter | |
| experimentName | No | Filter by specific experiment name | |
| budgetGroupName | No | Filter by specific budget group name | |
| maxAudienceSize | No | Maximum audience size threshold | |
| minAudienceSize | No | Minimum audience size threshold | |
| skipCustomFields | No | Skip custom fields in response | |
| customAudienceName | No | Filter by specific custom audience name | |
| usedInActiveExperiments | No | Filter for ingredients used in active experiments only | |
| launchedExperimentStatuses | No | Filter Performance Metrics by experiment launch statuses only. |