Skip to main content
GET
/
reporting
/
metrics
Get reporting
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/reporting/metrics \
  --header 'Authorization: Bearer <token>'
{
  "advertisers": [
    {
      "advertiserId": "<string>",
      "advertiserName": "<string>",
      "metrics": {
        "impressions": 4503599627370495,
        "spend": 1,
        "clicks": 4503599627370495,
        "views": 4503599627370495,
        "completedViews": 4503599627370495,
        "conversions": 4503599627370495,
        "leads": 4503599627370495,
        "videoCompletions": 4503599627370495,
        "ecpm": 123,
        "cpc": 123,
        "ctr": 123,
        "completionRate": 123
      },
      "campaigns": [
        {
          "campaignId": "<string>",
          "campaignName": "<string>",
          "metrics": {
            "impressions": 4503599627370495,
            "spend": 1,
            "clicks": 4503599627370495,
            "views": 4503599627370495,
            "completedViews": 4503599627370495,
            "conversions": 4503599627370495,
            "leads": 4503599627370495,
            "videoCompletions": 4503599627370495,
            "ecpm": 123,
            "cpc": 123,
            "ctr": 123,
            "completionRate": 123
          },
          "mediaBuys": [
            {
              "mediaBuyId": "<string>",
              "name": "<string>",
              "status": "<string>",
              "budget": 123,
              "metrics": {
                "impressions": 4503599627370495,
                "spend": 1,
                "clicks": 4503599627370495,
                "views": 4503599627370495,
                "completedViews": 4503599627370495,
                "conversions": 4503599627370495,
                "leads": 4503599627370495,
                "videoCompletions": 4503599627370495,
                "ecpm": 123,
                "cpc": 123,
                "ctr": 123,
                "completionRate": 123
              },
              "packages": [
                {
                  "packageId": "<string>",
                  "productId": "<string>",
                  "productName": "<string>",
                  "metrics": {
                    "impressions": 4503599627370495,
                    "spend": 1,
                    "clicks": 4503599627370495,
                    "views": 4503599627370495,
                    "completedViews": 4503599627370495,
                    "conversions": 4503599627370495,
                    "leads": 4503599627370495,
                    "videoCompletions": 4503599627370495,
                    "ecpm": 123,
                    "cpc": 123,
                    "ctr": 123,
                    "completionRate": 123
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totals": {
    "impressions": 4503599627370495,
    "spend": 1,
    "clicks": 4503599627370495,
    "views": 4503599627370495,
    "completedViews": 4503599627370495,
    "conversions": 4503599627370495,
    "leads": 4503599627370495,
    "videoCompletions": 4503599627370495,
    "ecpm": 123,
    "cpc": 123,
    "ctr": 123,
    "completionRate": 123
  },
  "periodStart": "<string>",
  "periodEnd": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key or access token

Query Parameters

​
advertiserId
string

Filter to campaigns on this advertiser (seat ID)

​
campaignId
string

Filter to a specific campaign. If advertiserId is also provided, the campaign must belong to that advertiser

​
startDate
string

Start date in ISO format (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-01-01"

​
endDate
string

End date in ISO format (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-01-31"

​
days
integer
default:7

Number of days to include (default: 7, max: 90). Use 0 for the full campaign timeframe.

Required range: 0 <= x <= 90
Example:

7

​
view
enum<string>
default:summary

Response format: "summary" for hierarchical advertiser/campaign/media-buy/package breakdown, "timeseries" for flat rows with one entry per (advertiser → campaign → media buy → package) × day

Available options:
summary,
timeseries
​
download
boolean
default:false

When true, generates a CSV file and returns a signed download URL instead of JSON data

​
demo
boolean
default:false
required

When true, returns auto-generated demo data instead of querying real data sources

Response

Get reporting

Hierarchical reporting response: advertiser → campaign → media buy → package

​
advertisers
object[]
required

Advertiser-level reporting data

​
totals
object
required

Aggregated totals across all advertisers

​
periodStart
string
required

Start of the reporting period (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
​
periodEnd
string
required

End of the reporting period (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$