Get Performance Metrics
performance_metricsGranular performance metrics for ads, audiences, creatives, offers, target groups, keywords. IMPORTANT: Always specify endpoint parameter. Always use ISO 8601 for dates.
USE FOR: Best performing ads/audiences/creatives/offers/target groups, ingredient comparisons, ad type analysis (IMAGE, VIDEO, CAROUSEL), lead gen forms vs landing pages, pipeline by ingredient, creative previews, keyword performance. NOT FOR: Account-level stats, experiment-level analysis without ingredient focus.
ENDPOINT LOGIC:
'target group' → customAudience/group
'audience' → customAudience
'offer'/'lead gen'/'landing page' → offer
'creative' → creative
'keyword' → keywords
'ad'/'ads' or default → ads
AD TYPES: IMAGE, VIDEO, CAROUSEL, DOCUMENT, CONVO, SPOTLIGHT, SEARCH, MESSAGE
The
adFormatfield on each response row identifies the ad type.
METRICS: spend, impressions, clicks, leads, mqls | opens, sends, actionClicks, costPerOpen, costPerSend (CONVO/MESSAGE ads) | cpl, cpc, cpm, ctr, conversionRate, formConversionRate, mqlRate | totalOpps, totalTriggered, oppsAmount, triggeredAmount | cpMql, cpOppInfluenced, cpOppTriggered | channel, goal, adFormat, audienceSize, statusLabel | previewUrl
CONVO/MESSAGE AD CAVEAT: when adFormat is CONVO or MESSAGE (LinkedIn message ads), success is measured by opens, sends, and actionClicks (and costPerOpen / costPerSend), NOT clicks/ctr/cpc. Do not rank these ads by CTR or dismiss them when clicks=0. Use sort='actionClicks,desc' or sort='opens,desc' for conversational performance ranking.
RULES: Field 'id' corresponds to endpoint queried. Exclude $0 CPL experiments from calculations.
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 | Number of results per page. Default 100; raise it freely (up to 10000) for comprehensive full-dataset analysis. | |
| 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. |