Overview
Use the advertiserReport query endpoint for deal performance reporting, available for all deals created with your TripleLift account (aka member) ID. The query endpoint provides the ability to specify dimensions, metrics, and filter values for query data, similar to the Reports for Advertisers in the TripleLift Platform.
Authentication
Please refer to the steps outlined in the Curation API Guide to obtain a token.
If you do not have credentials to access the Curation API, please contact your TripleLift representative.
advertiserReport
Refer to the GraphQL schema for the most up-to-date information on available options
| Category | Name | Description |
|---|---|---|
| DATE | YMD | Specifies the year, month, and day for data aggregation (YYYY-MM-DD); daily data is available for the past 15 months (UTC) |
| DATE | HOUR | Indicates the hour of the day in UTC for granular reporting. Hourly data is available starting from 00:00 (UTC) yesterday. |
| INVENTORY | APP_BUNDLE_ID | Unique identifier for a mobile or CTV application. |
| INVENTORY | DOMAIN | The web domain, mobile app bundle ID, or CTV app bundle ID where the ad was served. |
| INVENTORY | PUBLISHER_ID | Unique identifier for the publisher entity. This is the sellers.json identifier. |
| INVENTORY | PUBLISHER_NAME | The descriptive name of the publisher. |
| INVENTORY | AD_SIZE | Height & width fields in the oRTB Supplier Bid Response, which dictates the size of the ad container allocated by the publisher ad server |
| INVENTORY | SUPPLY_SOURCE | Describes the supply integration (Direct, Prebid, etc) with TripleLift. |
| INVENTORY | SUPPLY_TYPE | Describes whether the supply was web or app. |
| DEAL | DEAL_CODE | Specific code for a deal. |
| DEAL | DEAL_NAME | Descriptive name for a deal. |
| DEAL | DEAL_TYPE | Describes the type of deal (e.g. programmatic guaranteed, private marketplace or PMP, etc.). |
| BUYER | DSP | Demand side platform. |
| BUYER | DSP_SEAT_ID | Identifier for the demand-side platform seat. |
| BUYER | BRAND | The brand advertised in the creative. |
| BUYER | BRAND_DOMAIN | The adomain declared in the bid response, typically the primary website associated with the brand. |
| BUYER | PARENT_BRAND_NAME | The company that owns the brand; may be the same as brand. |
| CREATIVE | AD_SOLUTION | TripleLift advertising solution; may include a combination of format, connection type, video placement &/or template. |
| CREATIVE | FORMAT | TripleLift ad format name. |
| CREATIVE | EXTERNAL_CREATIVE_ID | Identifier for the demand-side creative. |
| CREATIVE | CREATIVE_ASSET_ID | A unique ID for the specific creative asset used in an ad. |
| CREATIVE | CREATIVE_DURATION | Measured length of time, expressed in seconds, that a non-static ad creative is intended to be displayed or played to a user, as submitted by the advertiser or creative source. |
| GEO | COUNTRY_NAME | The geographic country where the ad request originated. |
| GEO | DMA | Designated Metro Area (DMA), from the ad request |
| GEO | REGION | Geographic subdivisions defined by the International Organization of Standardization (ISO) |
| GEO | SECTOR | The geographic sector or continent where the ad request originated. |
| DEVICE | DEVICE_TYPE | Device category (desktop, mobile, tablet, CTV) |
| DEVICE | DEVICE_SUBTYPE | More specific classification of the device type. |
| DEVICE | DEVICE_VENDOR | The manufacturer of the device. |
| DEVICE | OS | Descriptive name for a deal. |
| DEVICE | BROWSER | The browser used by the consumer. |
| METRIC | AD_REQUESTS | The total number of requests made for an ad to be served (fka Impressions). |
| METRIC | BID_REQUESTS | The total number of bid requests sent to demand platforms; this number is estimated. |
| METRIC | BID_RESPONSE_RATE | Bid Response Rate, (Bid Responses / Bid Requests) |
| METRIC | BID_RESPONSES | The total number of bid responses received from demand platforms; this number is estimated. |
| METRIC | BILLABLE | The total number of ad requests that resulted in a billable event. |
| METRIC | CLICKS | The number of times consumers interacted with the ad by clicking. |
| METRIC | CPC | Cost per click (Spend / Clicks) |
| METRIC | CPCV | Cost per completed view (Spend / Video Completions) |
| METRIC | CTR | Click-through rate, (Clicks / Rendered) |
| METRIC | ECPM | Effective cost per mille (Spend / Billable) * 1000 |
| METRIC | FILL_RATE | Percentage of ad requests that resulted in a rendered ad (Rendered / Ad Requests) |
| METRIC | RENDER_RATE | Rendered Rate, (Renders / Wins) |
| METRIC | RENDERED | The total number of ad requests that resulted in an ad being shown. |
| METRIC | DEAL_SPEND | Advertising spend, excluding Added Value |
| METRIC | POST_AUCTION_DISCOUNT | Post Auction Discount (aka PAD), (Gross Spend - Deal Spend) |
| METRIC | TOTAL_AD_SPEND | Ad spend, including Added Value (aka Post Auction Discount or PAD), Unadjusted Spend (aka Spend, pre-PAD) |
| METRIC | TL_BID_RATE | Percentage of ad requests that TripleLift submitted to a publisher auction (TL Wins / Ad Requests) |
| METRIC | TL_WINS | The total number of ad requests that resulted in a won auction with TripleLift (prior to downstream, publisher auction) |
| METRIC | VCR | Video Completion Rate, (Video Completions / Video Starts) |
| METRIC | VIDEO_COMPLETIONS | The number of times a video ad played to its end. |
| METRIC | VIDEO_STARTS | The number of times a video ad began playing. |
| METRIC | VIDEO_Q1 | Percentage of video plays reaching the first quartile. |
| METRIC | VIDEO_Q2 | Percentage of video plays reaching the second quartile (50%). |
| METRIC | VIDEO_Q3 | Percentage of video plays reaching the third quartile. |
| METRIC | VSR | Video Start Rate, (Video Starts / Rendered) |
| METRIC | WIN RATE | Win Rate, (Wins / Bid Responses) |
| METRIC | WINS | The total number of ad requests that resulted in a won auction with the publisher (aka downstream wins). |
Endpoint Summary
Depending on your needs and workflow, use the endpoints below to request data from the advertiserReport query endpoint.
| Endpoint Name | Endpoint Type | Description |
|---|---|---|
| advertiserReport | Synchronous | Returns standard performance reporting data; limited to 5,000 rows |
| advertiserFilterOptions | Synchronous | Returns all possible filter IDs and values of a dimension in a given time period to be used in your queries |
| asyncDownloadAdvertiserReport | Asynchronous | Used for high volumes of data; responds immediately with a pre-signed S3 download link |
| asyncDownloadReportStatus | Asynchronous | Polling endpoint that accepts a pre-signed S3 link and returns the status of your report generation (READY, WAITING, or ERROR) |
| asyncEmailAdvertiserReport | Asynchronous | Used for high volumes of data; delivers the final CSV report to a specified list of valid email addresses |