Introduction

Welcome

Welcome to the Growth Channel API! This documentation will help you get started with our public endpoints to access your advertising campaign data. Our API is designed to be straightforward and easy to use. You can use it to retrieve performance metrics, auction data, and more.

Base URL

All endpoints are served from:

https://api.growthchannel.io

Authentication

All public endpoints require an agency API key, except Public API-KEY. To authenticate your requests, send your agency’s API key in the X-Api-Key header.

Example

curl --request GET \
  --url 'https://api.growthchannel.io/performance/?date_from=2026-01-01&date_to=2026-01-07' \
  --header 'X-Api-Key: YOUR_API_KEY'

If you don’t have an API key, please contact an administrator to have one generated for you. If the header is missing or the key is invalid, the API returns 401 Unauthorized:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "X-Api-Key header required",
    "details": {
      "field": "X-Api-Key",
      "issue": "missing"
    },
    "request_id": "..."
  }
}

For an invalid key, message is Invalid API key and details.issue is invalid.

Data scope

An API key belongs to an agency. Reports return data only for the advertisers that the key can access.

Agency key: access to all advertisers of the agency.
Portfolio key: a key issued to a white-label agency. It can access its own agency and every agency in its portfolio.

You can narrow a report with two optional query parameters:

Parameter	Description
`advertiser_id`	Return data for one advertiser only. It must belong to an agency that your key can access. Omit it to get all accessible advertisers.
`agency_id`	Return data for one agency only. It must be your agency or an agency in your portfolio.

advertiser_id is required for the Daily Auction report.

Common conventions

Dates

date_from and date_to are required on every report, in YYYY-MM-DD format.
Both dates are inclusive. A single day (date_from equal to date_to) is allowed.
date_from must not be after date_to.
The range between date_from and date_to cannot exceed 365 days.

Pagination

Reports that accept page return 20 rows per page.

page=1 is the first page.
If you omit page or send page=0, all rows are returned in one response.

Paginated responses include this object:

"pagination": {
  "current_page": 1,
  "total_pages": 5,
  "total_count": 89
}

Errors

All errors share the same format:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Date range cannot exceed 365 days",
    "details": {
      "date_from": "2025-01-01",
      "date_to": "2026-06-01",
      "date_range": 516,
      "max_allowed": 365
    },
    "request_id": "4cf3fd6c-b2a8-483d-bb50-f51255c4943c"
  }
}

Status	Code	When
400	`VALIDATION_ERROR`	A parameter is missing or invalid.
401	`UNAUTHORIZED`	The `X-Api-Key` header is missing or invalid.
403	`FORBIDDEN`	The key is not allowed to use this endpoint.
404	`NOT_FOUND`	The requested resource does not exist.
500	`INTERNAL_ERROR`	An unexpected server error occurred.

Today the API returns HTTP 200 for every response, including errors. Check body.error.code to tell success from failure instead of relying on the HTTP status.

Include request_id when you contact support about an error. Common validation messages:

Message	Cause
`Missing required parameters`	A required parameter is missing. `details.missing_fields` lists them.
`Invalid date format. Use YYYY-MM-DD format`	`date_from` or `date_to` is not a valid date.
`date_from must not be after date_to`	The dates are in the wrong order.
`Date range cannot exceed 365 days`	The date range is too long.
`advertiser_id must be a valid integer`	`advertiser_id` is not a number.
`advertiser_id not found`	The advertiser does not exist.
`advertiser_id is not associated with the agency`	Your key cannot access this advertiser.
`agency_id must be a valid integer`	`agency_id` is not a number.
`agency_id is not associated with the API key portfolio`	Your key cannot access this agency.

Metrics

Calculated metrics are rounded to 3 decimal places. A metric is 0 when its denominator is 0.

Metric	Formula
`ctr`	clicks × 100 / impressions
`cpm`	total_spend × 1000 / impressions
`cpc`	total_spend / clicks
`cpa`	total_spend / total_conversions
`cpv`	total_spend / impressions
`cpv_video`	total_spend / video_audio_views
`cpcv_video`	total_spend / video_audio_complete
`vcr`	video_audio_complete × 100 / video_audio_views
`roas`	total_revenue / total_spend
`frequency`	impressions / reach

API documentation

Public endpoints

Welcome

Base URL

Authentication

Data scope

Common conventions

Dates

Errors

Metrics

​Welcome

​Base URL

​Authentication

​Data scope

​Common conventions

​Dates

​Pagination

​Errors

​Metrics

Welcome

Base URL

Authentication

Data scope

Common conventions

Dates

Pagination

Errors

Metrics