Skip to main content
GET
Fetch insight

Overview

Return performance metrics for an ad. Targeter uses this to populate campaign stats in the app. Dates are inclusive YYYY-MM-DD. Omit both from_date and to_date to return lifetime totals from the ad start_date through today. Metrics should match what Targeter already shows on campaigns: impressions, clicks, spend, CPM, CPC, CTR, reach, frequency, conversions, and video quartiles when the creative is video.

Request

Headers

  • Authorization: Bearer {token} (required)

Path Parameters

string
required
Publisher-generated ad id returned from Create ad

Query Parameters

string
Start of the reporting window (inclusive)
string
End of the reporting window (inclusive)

Example Request

Response

Success (200)

string
Publisher-generated ad id
object
Aggregated metrics for the requested window
integer
Total ad impressions
integer
Total ad clicks
number
Amount spent in insights.currency
string
ISO 4217 currency code
number
Cost per 1,000 impressions
number
Cost per click
number
Click-through rate (clicks / impressions)
integer
Unique people reached
number
Average impressions per person reached
integer
Total conversions
number
Average cost per conversion
object
Video completion quartiles (p25, p50, p75, p100). Omit when the ad has no video.
string
Start of the window actually returned
string
End of the window actually returned
Return zeros rather than omitting core counters (impressions, clicks, spend) when the ad has not delivered yet.

Error Responses

400 - Invalid request payload

401 - Unauthorized

404 - Ad not found

500 - Server Error

Authorizations

Authorization
string
header
required

API token issued to Targeter during integration setup. Send as Authorization: Bearer <token>.

Path Parameters

ad_id
string
required

Publisher-generated ad id returned from POST /ads

Query Parameters

from_date
string<date>

Start of the reporting window (inclusive). ISO 8601 date.

to_date
string<date>

End of the reporting window (inclusive). ISO 8601 date.

Response

Insights for the requested window

ad_id
string
required
Example:

"ad_9pL2wR"

insights
object
required