Geo Report

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=country

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=region

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=zip_code

GET

geo

?date_from=

{date_from}

&date_to=

{date_to}

&advertiser_id=

{advertiser_id}

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=country

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=region

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=zip_code

Maximum date range 365 days

This endpoint is protected and requires an agency API key for access.

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=country

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=region

  curl --request GET \
    --url https://api.growthchannel.io/geo/?date_from=2024-01-01&date_to=2024-01-07&advertiser_id=544&breakout=zip_code

Method

GET

Endpoint

/geo/

Headers

string

required

The agency’s API key for authorization. Contact an admin to get one.

Parameters

string

required

Start date in YYYY-MM-DD format.

string

required

End date in YYYY-MM-DD format.

integer

required

The unique identifier for the advertiser.

integer

default:"0"

Page number for pagination.

string

default:"country"

Geographic breakdown level (country/region/zip_code).

integer

Filter by a specific campaign ID.

Breakout Options

The breakout parameter determines the level of geographic detail in the report.

country: Aggregates data by country.
region: Aggregates data by state or region.
zip_code: Aggregates data by postal code.

Responses

{
  "data": [
    {
      "country": "US",
      "impressions": 1000,
      "clicks": 50,
      "total_conversions": 0,
      "video_audio_views": 0,
      "video_audio_complete": 0,
      "total_revenue": 0.0,
      "total_spend": 0.005,
      "cpm": 5.126,
      "cpc": 0.0,
      "cpa": 0.0,
      "cpv": 0.005,
      "cpv_video": 0.0,
      "cpcv_video": 0.0,
      "roas": 0.0,
      "vcr": 0.0,
      "ctr": 0.0
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 5,
    "total_count": 100
  },
  "breakout": "country"
}

array

An array of geographic performance objects. The location key (country, region, or zip_code) depends on the breakout parameter used in the request.

object

An object containing pagination details.

{
  "data": [
    {
      "country": "US",
      "region": "Jalisco",
      "impressions": 1000,
      "clicks": 50,
      "total_conversions": 0,
      "video_audio_views": 0,
      "video_audio_complete": 0,
      "total_revenue": 0.0,
      "total_spend": 0.005,
      "cpm": 5.126,
      "cpc": 0.0,
      "cpa": 0.0,
      "cpv": 0.005,
      "cpv_video": 0.0,
      "cpcv_video": 0.0,
      "roas": 0.0,
      "vcr": 0.0,
      "ctr": 0.0
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 5,
    "total_count": 100
  },
  "breakout": "region"
}

array

An array of geographic performance objects. The location key (country, region, or zip_code) depends on the breakout parameter used in the request.

object

An object containing pagination details.

{
  "data": [
    {
      "country": "US",
      "zip_code": "60074",
      "impressions": 1000,
      "clicks": 50,
      "total_conversions": 0,
      "video_audio_views": 0,
      "video_audio_complete": 0,
      "total_revenue": 0.0,
      "total_spend": 0.005,
      "cpm": 5.126,
      "cpc": 0.0,
      "cpa": 0.0,
      "cpv": 0.005,
      "cpv_video": 0.0,
      "cpcv_video": 0.0,
      "roas": 0.0,
      "vcr": 0.0,
      "ctr": 0.0
    }
  ],
  "pagination": {
    "current_page": 0,
    "total_pages": 5,
    "total_count": 100
  },
  "breakout": "region"
}

array

An array of geographic performance objects. The location key (country, region, or zip_code) depends on the breakout parameter used in the request.

object

An object containing pagination details.

Returned if the X-Api-Key header is missing or invalid.

Creative Report Domain Report

API documentation

Public endpoints

Method

Endpoint

Headers

Parameters

Breakout Options

Responses

Method

Endpoint

​Headers

​Parameters

​Breakout Options

​Responses

Headers

Parameters

Breakout Options

Responses