{
"opencollection": "1.0.0",
"info": {
"name": "Ads Manager API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Accounts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/accounts",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of accounts to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sorts accounts by name"
},
{
"name": "updated_since",
"value": "",
"type": "query",
"description": "Limits results to accounts updated since a unix timestamp"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "organization_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets accounts in an organization"
},
{
"info": {
"name": "Create Account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/accounts",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "organization_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates an account"
},
{
"info": {
"name": "Get Account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/accounts/:account_id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets an account"
},
{
"info": {
"name": "Update Account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/accounts/:account_id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates an account"
},
{
"info": {
"name": "Delete Account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/accounts/:account_id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "organization_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes an account"
},
{
"info": {
"name": "Get Account Min Cpv Bid Rate",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/accounts/:account_id/min_cpv_bid_rate",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the minimum CPV bid rate for an account"
},
{
"info": {
"name": "Get Account Pixels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/accounts/:account_id/pixels",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of account pixels to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sorts account pixels by name"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets pixels for an account"
},
{
"info": {
"name": "Create Account Pixel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/accounts/:account_id/pixels",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates an account pixel"
},
{
"info": {
"name": "Get Account Pixels Export",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/accounts/:account_id/pixels/export",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Downloads a spreadsheet with account pixel information"
},
{
"info": {
"name": "Delete Account Pixel",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/accounts/:account_id/pixels/:pixel_id",
"params": [
{
"name": "pixel_id",
"value": "",
"type": "path"
},
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes an account pixel"
}
]
},
{
"info": {
"name": "Ad Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/adgroups",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of ad groups to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sorts ad groups by name"
},
{
"name": "updated_since",
"value": "",
"type": "query",
"description": "Limits results to ad adgroups updated since a unix timestamp"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets all ad groups in a campaign"
},
{
"info": {
"name": "Create Adgroup",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/adgroups",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates an ad group"
},
{
"info": {
"name": "Create Dooh Adgroups",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/adgroups/dooh",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates dooh ad groups with plan data"
},
{
"info": {
"name": "Get Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets an ad group"
},
{
"info": {
"name": "Update Adgroup",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates an ad group"
},
{
"info": {
"name": "Patch Adgroup",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Patches an ad group"
},
{
"info": {
"name": "Delete Adgroup",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes an ad group"
},
{
"info": {
"name": "Get Adgroup Avails",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id/avails",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets avails for an ad group"
},
{
"info": {
"name": "Download Location Filters",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id/location_filters/download",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Downloads location filters for an ad group"
},
{
"info": {
"name": "Clone Adgroup",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/adgroups/:adgroup_id/clone",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Clones an ad group once per requested media type with the given objective"
}
]
},
{
"info": {
"name": "Audiences",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Audience Taxonomy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/audiences/audience_taxonomy",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets entire audience taxonomy for a tenant and account"
},
{
"info": {
"name": "Get Audience Recommendations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/audiences/recommendations",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience recommendations based on current selections"
}
]
},
{
"info": {
"name": "Campaigns",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Campaigns",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/campaigns",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of campaigns to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sorts campaigns by name"
},
{
"name": "updated_since",
"value": "",
"type": "query",
"description": "Limits results to campaigns updated since a unix timestamp"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets all campaigns in an account"
},
{
"info": {
"name": "Create Campaign",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/campaigns",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates a campaign"
},
{
"info": {
"name": "Create Campaign And Adgroups",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/campaigns/with_adgroups",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates a campaign and ad groups together"
},
{
"info": {
"name": "Get Campaigns Dashboard",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/campaigns/dashboard",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of campaigns to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Field to sort campaigns by (non-reporting columns only)"
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sort order"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Include campaigns that overlap this range start (end_date >= start_date or open-ended). Also used as reporting metrics start date (YYYY-MM-DD)."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Include campaigns that overlap this range end (start_date <= end_date). Also used as reporting metrics end date (YYYY-MM-DD)."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter by campaign statuses"
},
{
"name": "account_ids",
"value": "",
"type": "query",
"description": "Filter by account ID(s)"
},
{
"name": "organization_ids",
"value": "",
"type": "query",
"description": "Filter by organization ID(s)"
},
{
"name": "objectives",
"value": "",
"type": "query",
"description": "Filter by ad group objectives. Returns campaigns with at least one matching ad group."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search by campaign name or ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets campaigns in a tenant"
},
{
"info": {
"name": "Export Campaigns Dashboard",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/campaigns/dashboard/export",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Exports campaigns in a tenant as an Excel file"
},
{
"info": {
"name": "Get Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/campaigns/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets a campaign"
},
{
"info": {
"name": "Update Campaign",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/campaigns/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates a campaign"
},
{
"info": {
"name": "Delete Campaign",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/campaigns/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes a campaign"
},
{
"info": {
"name": "Create Ad Package",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/campaigns/:campaign_id/ad_packages",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates an ad package"
}
]
},
{
"info": {
"name": "Creative Assets",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Creative Assets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/creative_assets",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of creative assets to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Field to sort creative assets by"
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sort order for creative assets"
},
{
"name": "updated_date_from",
"value": "",
"type": "query",
"description": "Filter to creative assets updated on or after this date"
},
{
"name": "updated_date_to",
"value": "",
"type": "query",
"description": "Filter to creative assets updated on or before this date"
},
{
"name": "sizes",
"value": "",
"type": "query",
"description": "Filter by size(s)"
},
{
"name": "file_extensions",
"value": "",
"type": "query",
"description": "Filter by file extension(s)"
},
{
"name": "created_date_from",
"value": "",
"type": "query",
"description": "Filter to creative assets created on or after this date"
},
{
"name": "created_date_to",
"value": "",
"type": "query",
"description": "Filter to creative assets created on or before this date"
},
{
"name": "created_by",
"value": "",
"type": "query",
"description": "Filter by creator user ID"
},
{
"name": "organization_ids",
"value": "",
"type": "query",
"description": "Filter by organization ID(s)"
},
{
"name": "account_ids",
"value": "",
"type": "query",
"description": "Filter by account ID(s)"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter by status(es)"
},
{
"name": "types",
"value": "",
"type": "query",
"description": "Filter by asset type(s)"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Search by name (case-insensitive substring match)"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search by name (alias for name)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets creative assets in a tenant"
},
{
"info": {
"name": "Get Creative Asset",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/creative_assets/:creative_asset_id",
"params": [
{
"name": "creative_asset_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets a creative asset"
},
{
"info": {
"name": "Delete Creative Asset",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/creative_assets/:creative_asset_id",
"params": [
{
"name": "creative_asset_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes a creative asset"
}
]
},
{
"info": {
"name": "Creatives",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/creatives",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of creatives to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sorts creatives by name"
},
{
"name": "updated_since",
"value": "",
"type": "query",
"description": "Limits results to creatives updated since a unix timestamp"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "adgroup_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets all creatives in an ad group"
},
{
"info": {
"name": "Create Creative",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/creatives",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "adgroup_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates a creative"
},
{
"info": {
"name": "Patch Creatives",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api-public.groundtruth.com/creatives",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Patches multiple creatives in a campaign"
},
{
"info": {
"name": "Get Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/creatives/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets a creative"
},
{
"info": {
"name": "Update Creative",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/creatives/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates a creative"
},
{
"info": {
"name": "Patch Creative",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api-public.groundtruth.com/creatives/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Patches a creative"
},
{
"info": {
"name": "Clone Creative",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/creatives/:creative_id/clone",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Clones a creative"
},
{
"info": {
"name": "Get Creative Preview",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/creatives/:creative_id/preview",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the creative preview using the stored CMS configuration. Video creatives return VAST XML; other types return HTML."
},
{
"info": {
"name": "Get Creative Landing Page Preview",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/creatives/:creative_id/landing_page_preview",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the landing page preview HTML for a creative"
}
]
},
{
"info": {
"name": "Direct Mail",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Orders",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/direct_mail/orders",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of orders to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets direct mail orders for a tenant"
}
]
},
{
"info": {
"name": "Health",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Health",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/health"
},
"docs": "Gets server health"
}
]
},
{
"info": {
"name": "Jobs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/jobs",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "adgroup_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
},
{
"name": "job_type",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets jobs"
},
{
"info": {
"name": "Get Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/jobs/:job_id",
"params": [
{
"name": "job_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets a job"
},
{
"info": {
"name": "Create Campaign Bulk Upload Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/campaign_bulk_upload",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates a campaign bulk upload job"
},
{
"info": {
"name": "Cancel Campaign Bulk Upload Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/campaign_bulk_upload/:job_id/cancel",
"params": [
{
"name": "job_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Cancels a campaign bulk upload job"
},
{
"info": {
"name": "Confirm Campaign Bulk Upload Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/campaign_bulk_upload/:job_id/confirm",
"params": [
{
"name": "job_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Confirms a campaign bulk upload job"
},
{
"info": {
"name": "Create Location Filter Bulk Upload Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/location_filter_bulk_upload",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "adgroup_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates a location filter bulk upload job"
},
{
"info": {
"name": "Create Campaign Bulk Download Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/campaign_bulk_download",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates a campaign bulk download job"
},
{
"info": {
"name": "Confirm Location Filter Bulk Upload Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/location_filter_bulk_upload/:job_id/confirm",
"params": [
{
"name": "job_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "adgroup_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Confirms location filter bulk upload job"
},
{
"info": {
"name": "Cancel Location Filter Bulk Upload Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/jobs/location_filter_bulk_upload/:job_id/cancel",
"params": [
{
"name": "job_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "adgroup_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Cancels location filter bulk upload job"
}
]
},
{
"info": {
"name": "Organizations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/organizations",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of organizations to limit response to"
},
{
"name": "page_num",
"value": "",
"type": "query",
"description": "Page number to retrieve. Starts at 1."
},
{
"name": "sort_order",
"value": "",
"type": "query",
"description": "Sorts organizations by name"
},
{
"name": "updated_since",
"value": "",
"type": "query",
"description": "Limits results to organization updated since a unix timestamp"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets organizations in a tenant"
},
{
"info": {
"name": "Create Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/organizations",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Creates an organization"
},
{
"info": {
"name": "Get Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/organizations/:organization_id",
"params": [
{
"name": "organization_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets an organization"
},
{
"info": {
"name": "Update Organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/organizations/:organization_id",
"params": [
{
"name": "organization_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates an organization"
},
{
"info": {
"name": "Delete Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/organizations/:organization_id",
"params": [
{
"name": "organization_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes an organization"
}
]
},
{
"info": {
"name": "Reporting",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Supply System Distribution Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/distribution/supply/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1=device type, 2=operating system, 3=publisher type"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, returns distribution grouped by ad group where applicable."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets supply/system distribution for a campaign. key=1 device type, key=2 operating system, key=3 publisher type. Optional all_adgroups breaks out by ad group."
},
{
"info": {
"name": "Get Performance Distribution Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/distribution/performance/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1=product, 2=goal KPI (not available)"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, returns distribution grouped by ad group."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets performance distribution for a campaign. key=1 product. key=2 goal KPI is not available in this version. Optional all_adgroups breaks out by ad group."
},
{
"info": {
"name": "Get Supply System Distribution Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/distribution/supply/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1=device type, 2=operating system, 3=publisher type"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets supply/system distribution for an ad group. key=1 device type, key=2 operating system, key=3 publisher type."
},
{
"info": {
"name": "Get Performance Distribution Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/distribution/performance/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1=product, 2=goal KPI"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets performance distribution for an ad group. key=1 product, key=2 goal KPI."
},
{
"info": {
"name": "Get Ctv Ott Performance Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/ctv_ott/performance/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV/OTT Performance Report for a campaign"
},
{
"info": {
"name": "Get Ctv Ott Performance Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/ctv_ott/performance/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV/OTT Performance Report for adgroups in a campaign"
},
{
"info": {
"name": "Get Dow Metrics Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/dow/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by day and ad group"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets day-of-week metrics for a campaign; optionally by ad group when all_adgroups=true"
},
{
"info": {
"name": "Get Dow Metrics Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/dow/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets day-of-week metrics for a creative."
},
{
"info": {
"name": "Get Timeseries Dow Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week chart for an ad group"
},
{
"info": {
"name": "Get Dow Metrics Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/dow/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by day of week and creative"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets day-of-week metrics for an ad group; optionally by creative when all_creatives=true"
},
{
"info": {
"name": "Get Tod Metrics Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tod/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by hour and creative"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets time-of-day hourly metrics for an ad group; optionally by creative when all_creatives=true"
},
{
"info": {
"name": "Get Tod Weekday Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tod/weekday/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by hour and ad group"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets weekday time-of-day hourly metrics for a campaign; optionally by ad group."
},
{
"info": {
"name": "Get Tod Weekday Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tod/weekday/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by hour and creative"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets weekday time-of-day hourly metrics for an ad group; optionally by creative."
},
{
"info": {
"name": "Get Tod Weekend Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tod/weekend/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by hour and creative"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets weekend time-of-day hourly metrics for an ad group; optionally by creative."
},
{
"info": {
"name": "Get Tod Weekend Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tod/weekend/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, return metrics grouped by hour and ad group"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets weekend time-of-day hourly metrics for a campaign; optionally by ad group."
},
{
"info": {
"name": "Get Timeseries Dow Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day
- campaign_id
- campaign_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day, campaign_id, and campaign_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week chart for a campaign"
},
{
"info": {
"name": "Get Timeseries Dow Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week metrics for each ad group in a campaign."
},
{
"info": {
"name": "Get Timeseries Dow Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week metrics for each creative in a campaign."
},
{
"info": {
"name": "Get Timeseries Dow Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week chart for a creative"
},
{
"info": {
"name": "Get Timeseries Dow Tod Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow_tod/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Data type: chart (averaged metrics) or full (summed totals with video breakdown)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day_type
- day
- hr
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day_type, day, and hr are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week and time of day metrics for a campaign."
},
{
"info": {
"name": "Get Timeseries Dow Tod Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow_tod/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day_type
- day
- hr
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day_type, day, hr, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week and time of day metrics for each ad group in a campaign."
},
{
"info": {
"name": "Get Timeseries Dow Tod Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow_tod/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day_type
- day
- hr
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day_type, day, hr, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week and time of day metrics for each creative in a campaign."
},
{
"info": {
"name": "Get Timeseries Dow Tod Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow_tod/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Data type: chart (averaged metrics) or full (summed totals with video breakdown)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day_type
- day
- hr
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day_type, day, and hr are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week and time of day metrics for an ad group."
},
{
"info": {
"name": "Get Timeseries Dow Tod Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/dow_tod/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "data_type",
"value": "",
"type": "query",
"description": "Data type: chart (averaged metrics) or full (summed totals with video breakdown)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- day_type
- day
- hr
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end
Note: day_type, day, hr, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries day of week and time of day metrics for a creative."
},
{
"info": {
"name": "Get Timeseries Tod Imp Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/tod/imp/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "imp",
"value": "",
"type": "query",
"description": "Include impressions"
},
{
"name": "vst",
"value": "",
"type": "query",
"description": "Include visits"
},
{
"name": "oh_vst",
"value": "",
"type": "query",
"description": "Include open hour visits"
},
{
"name": "clks",
"value": "",
"type": "query",
"description": "Include clicks"
},
{
"name": "ctr",
"value": "",
"type": "query",
"description": "Include click-through rate"
},
{
"name": "spt",
"value": "",
"type": "query",
"description": "Include spend"
},
{
"name": "sa",
"value": "",
"type": "query",
"description": "Include secondary actions"
},
{
"name": "sar",
"value": "",
"type": "query",
"description": "Include secondary action rate"
},
{
"name": "vcr",
"value": "",
"type": "query",
"description": "Include video completion rate"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets time-of-day chart metrics for a campaign."
},
{
"info": {
"name": "Get Timeseries Tod Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/tod/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of metric fields to include in the response. At least one is required.
Available values:
- imp
- vst
- oh_vst
- clks
- ctr
- spt
- sa
- sar
- vcr"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets time-of-day chart metrics for each ad group in a campaign."
},
{
"info": {
"name": "Get Timeseries Tod Creatives Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/tod/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of metric fields to include in the response. At least one is required.
Available values:
- imp
- vst
- oh_vst
- clks
- ctr
- spt
- sa
- sar
- vcr"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets time-of-day chart metrics for each creative in a campaign."
},
{
"info": {
"name": "Get Timeseries Tod Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/tod/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets time-of-day chart metrics for an ad group."
},
{
"info": {
"name": "Get Timeseries Tod Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/timeseries/tod/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "imp",
"value": "",
"type": "query",
"description": "Include impressions"
},
{
"name": "vst",
"value": "",
"type": "query",
"description": "Include visits"
},
{
"name": "oh_vst",
"value": "",
"type": "query",
"description": "Include open hour visits"
},
{
"name": "clks",
"value": "",
"type": "query",
"description": "Include clicks"
},
{
"name": "ctr",
"value": "",
"type": "query",
"description": "Include click-through rate"
},
{
"name": "spt",
"value": "",
"type": "query",
"description": "Include spend"
},
{
"name": "sa",
"value": "",
"type": "query",
"description": "Include secondary actions"
},
{
"name": "sar",
"value": "",
"type": "query",
"description": "Include secondary action rate"
},
{
"name": "vcr",
"value": "",
"type": "query",
"description": "Include video completion rate"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets time-of-day chart metrics for a creative."
},
{
"info": {
"name": "Get Product Insights Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/product/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "is_export",
"value": "",
"type": "query",
"description": "Get POI / Geotarget level details using this flag"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "category",
"value": "",
"type": "query",
"description": "Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "products",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint
Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets product insights for a campaign"
},
{
"info": {
"name": "Get Product Insights Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/targeting_tactic/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "category",
"value": "",
"type": "query",
"description": "Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "products",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint
Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets product insights for an adgroup"
},
{
"info": {
"name": "Get Product Insights Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/targeting_tactic/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "category",
"value": "",
"type": "query",
"description": "Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "products",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint
Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields."
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets product insights for a creative"
},
{
"info": {
"name": "Get Product Insights Campaign Targeting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/product/campaign/:campaign_id/targeting",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top N (defaults to 5) targeting strategies sorted by impressions, CTR, and VR for a campaign"
},
{
"info": {
"name": "Get Product Insights Campaign Audience",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/product/campaign/:campaign_id/audience",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of audiences to return"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top N (defaults to 5) audiences sorted by impressions, clicks, and visits for a campaign"
},
{
"info": {
"name": "Get Product Insights Adgroup Targeting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/product/adgroup/:adgroup_id/targeting",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top N (defaults to 5) targeting strategies sorted by impressions, CTR, and VR for an adgroup"
},
{
"info": {
"name": "Get Product Insights Adgroup Audience",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/product/adgroup/:adgroup_id/audience",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of audiences to return"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top N (defaults to 5) audiences sorted by impressions, clicks, and visits for an adgroup"
},
{
"info": {
"name": "Get Product Insights Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/targeting_tactic/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "category",
"value": "",
"type": "query",
"description": "Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets product insights for all ad groups in a campaign."
},
{
"info": {
"name": "Get Product Insights Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/targeting_tactic/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "category",
"value": "",
"type": "query",
"description": "Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets product insights for all creatives in a campaign."
},
{
"info": {
"name": "Get Visitation Lag Window Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/visitation/lag_window/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the number of visits after impressions and clicks."
},
{
"info": {
"name": "Get Visitation Svl Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/visitation/svl/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets store visitation lift metrics for a campaign."
},
{
"info": {
"name": "Get Userinsight Visit",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/userinsight/visit",
"params": [
{
"name": "key",
"value": "",
"type": "query",
"description": "Membership type: 1=brand, 2=category, 3=behavioral audience"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets visit membership breakdown by brand (key=1), category (key=2), or behavioral audience (key=3)."
},
{
"info": {
"name": "Get Userinsight Visit Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/userinsight/visit/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Membership type: brand (1), category (2), or behaviour (3)."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets adgroup-level visit membership breakdown (user insight): brand, category, or behaviour."
},
{
"info": {
"name": "Get Userinsight Visit Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/userinsight/visit/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Membership type: brand (1), category (2), or behaviour (3)."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets campaign-level visit membership breakdown (user insight): brand, category, or behaviour."
},
{
"info": {
"name": "Get Visitation Lag Window Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/visitation/lag_window/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the number of visits after impressions and clicks for an ad group."
},
{
"info": {
"name": "Get Visitation Lag Window Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/visitation/lag_window/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the number of visits after impressions and clicks for a creative."
},
{
"info": {
"name": "Get Incremental Visits Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/incremental_visits/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets incremental visits by visit frequency bucket for a campaign."
},
{
"info": {
"name": "Get Incremental Visits Campaign Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/incremental_visits/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets incremental visits by visit frequency bucket for each ad group in a campaign."
},
{
"info": {
"name": "Get Incremental Visits Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/incremental_visits/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets incremental visits by visit frequency bucket for each creative in a campaign."
},
{
"info": {
"name": "Get Incremental Visits Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/incremental_visits/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets incremental visits by visit frequency bucket for an ad group."
},
{
"info": {
"name": "Get Incremental Visits Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/incremental_visits/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets incremental visits by visit frequency bucket for a creative."
},
{
"info": {
"name": "Get Locations Imp Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/locations/imp/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets impressed locations for an ad group."
},
{
"info": {
"name": "Get Locations Imp Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/locations/imp/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, returns impressed locations grouped by ad group."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets impressed locations for a campaign."
},
{
"info": {
"name": "Get Locations Visit Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/locations/visit/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, returns visited locations grouped by ad group."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets visited locations for a campaign."
},
{
"info": {
"name": "Get Locations Visit Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/locations/visit/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets visited locations for an ad group."
},
{
"info": {
"name": "Get Top Locations Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/top_locations/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "Location type: state, dma, or zipcode"
},
{
"name": "metric",
"value": "",
"type": "query",
"description": "Metric to sort by: impressions, clicks, ctr, secondary_actions, or visits"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for top locations, 2 for bottom locations, 0 for all records (no limit)"
},
{
"name": "sw_lat",
"value": "",
"type": "query",
"description": "Southwestern latitude"
},
{
"name": "sw_lng",
"value": "",
"type": "query",
"description": "Southwestern longitude"
},
{
"name": "ne_lat",
"value": "",
"type": "query",
"description": "Northeastern latitude"
},
{
"name": "ne_lng",
"value": "",
"type": "query",
"description": "Northeastern longitude"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of locations to return"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top locations (impressions-based) for a campaign by state, DMA, or zipcode."
},
{
"info": {
"name": "Get Top Locations Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/top_locations/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "Location type: state, dma, or zipcode"
},
{
"name": "metric",
"value": "",
"type": "query",
"description": "Metric to sort by: impressions, clicks, ctr, secondary_actions, or visits"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for top locations, 2 for bottom locations, 0 for all records (no limit)"
},
{
"name": "sw_lat",
"value": "",
"type": "query",
"description": "Southwestern latitude"
},
{
"name": "sw_lng",
"value": "",
"type": "query",
"description": "Southwestern longitude"
},
{
"name": "ne_lat",
"value": "",
"type": "query",
"description": "Northeastern latitude"
},
{
"name": "ne_lng",
"value": "",
"type": "query",
"description": "Northeastern longitude"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of locations to return"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top locations (impressions-based) for an ad group by state, DMA, or zipcode."
},
{
"info": {
"name": "Get Top Sv Locations Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/top_sv_locations/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "Please select a location type"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Enter 1 to get top 10 locations, 2 to get bottom 10 locations, 0 to get all the records"
},
{
"name": "sw_lat",
"value": "",
"type": "query",
"description": "Southwestern Latitude Coordinates"
},
{
"name": "sw_lng",
"value": "",
"type": "query",
"description": "Southwestern Longitude Coordinates"
},
{
"name": "ne_lat",
"value": "",
"type": "query",
"description": "Northeastern Latitude Coordinates"
},
{
"name": "ne_lng",
"value": "",
"type": "query",
"description": "Northeastern Longitude Coordinates"
},
{
"name": "blueprint_polygon_info",
"value": "",
"type": "query",
"description": "Includes blueprint polygon data in the output (applicable only for \"address\" type locations)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of locations to return"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets data for visited locations."
},
{
"info": {
"name": "Get Top Sv Locations Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/top_sv_locations/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "Please select a location type"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Enter 1 to get top 10 locations, 2 to get bottom 10 locations, 0 to get all the records"
},
{
"name": "sw_lat",
"value": "",
"type": "query",
"description": "Southwestern Latitude Coordinates"
},
{
"name": "sw_lng",
"value": "",
"type": "query",
"description": "Southwestern Longitude Coordinates"
},
{
"name": "ne_lat",
"value": "",
"type": "query",
"description": "Northeastern Latitude Coordinates"
},
{
"name": "ne_lng",
"value": "",
"type": "query",
"description": "Northeastern Longitude Coordinates"
},
{
"name": "blueprint_polygon_info",
"value": "",
"type": "query",
"description": "Includes blueprint polygon data in the output (applicable only for \"address\" type locations)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of locations to return"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets data for visited locations for an ad group."
},
{
"info": {
"name": "Get Top Imp Locations Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/top_imp_locations/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "Location type"
},
{
"name": "metric",
"value": "",
"type": "query",
"description": "Metric to sort by (impressions, clicks, total_sa)"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for top locations, 2 for bottom locations"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Max number of records; use -1 for no limit"
},
{
"name": "sw_lat",
"value": "",
"type": "query",
"description": "Southwestern latitude (bounding box)"
},
{
"name": "sw_lng",
"value": "",
"type": "query",
"description": "Southwestern longitude (bounding box)"
},
{
"name": "ne_lat",
"value": "",
"type": "query",
"description": "Northeastern latitude (bounding box)"
},
{
"name": "ne_lng",
"value": "",
"type": "query",
"description": "Northeastern longitude (bounding box)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top or bottom locations by impressions, clicks, or secondary actions for a campaign."
},
{
"info": {
"name": "Get Top Imp Locations Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/top_imp_locations/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "location_type",
"value": "",
"type": "query",
"description": "Location type"
},
{
"name": "metric",
"value": "",
"type": "query",
"description": "Metric to sort by (impressions, clicks, total_sa)"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for top locations, 2 for bottom locations"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Max number of records; use -1 for no limit"
},
{
"name": "sw_lat",
"value": "",
"type": "query",
"description": "Southwestern latitude (bounding box)"
},
{
"name": "sw_lng",
"value": "",
"type": "query",
"description": "Southwestern longitude (bounding box)"
},
{
"name": "ne_lat",
"value": "",
"type": "query",
"description": "Northeastern latitude (bounding box)"
},
{
"name": "ne_lng",
"value": "",
"type": "query",
"description": "Northeastern longitude (bounding box)"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top or bottom locations by impressions, clicks, or secondary actions for an ad group."
},
{
"info": {
"name": "Get Totals Account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/account/:account_id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets cumulative performance metrics for all campaigns in an account"
},
{
"info": {
"name": "Get Totals Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/organization/:organization_id",
"params": [
{
"name": "organization_id",
"value": "",
"type": "path",
"description": "Organization ID"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query",
"description": "Tenant ID"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets cumulative performance metrics for all campaigns in an organization"
},
{
"info": {
"name": "Post Totals Tenant",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/reporting/totals/tenant",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets tenant-level totals with up-to-date spend for a list of campaigns"
},
{
"info": {
"name": "Get Totals Account V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/v2/account/:account_id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets account-level totals v2 with up-to-date spend"
},
{
"info": {
"name": "Get Total Attributed Visits Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tav/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "post_date",
"value": "",
"type": "query",
"description": "Post date in YYYY-MM-DD"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Version filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets total attributed visits estimate for a specific campaign"
},
{
"info": {
"name": "Get Total Attributed Visits Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/tav/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "post_date",
"value": "",
"type": "query",
"description": "Post date in YYYY-MM-DD"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Version filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets total attributed visits estimate per ad group for a specific campaign"
},
{
"info": {
"name": "Get Totals Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets detailed performance metrics for a specific campaign"
},
{
"info": {
"name": "Get Totals Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, return report grouped by creative id"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets cumulative performance metrics for an ad group; optionally grouped by creative when all_creatives=true"
},
{
"info": {
"name": "Get Demographics Partial Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/demographics/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Filter of enabled metrics. Allowed: imp,vst,clks,ctr,rch,vcr,ltr. Provide at least one."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets adgroup demographics (partial) metrics by gender and age"
},
{
"info": {
"name": "Get Totals Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets cumulative performance metrics for a creative"
},
{
"info": {
"name": "Get Totals Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/totals/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Number of creatives to limit response to"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets top N (defaults to 3) creatives with the most impressions for a specific campaign"
},
{
"info": {
"name": "Get Audio Podcast Topic Metrics Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/podcast_topic/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "Get all adgroups"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Audio podcast topic metrics for a specific campaign."
},
{
"info": {
"name": "Get Audio Podcast Topic Metrics Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/podcast_topic/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Audio podcast topic metrics for a specific adgroup."
},
{
"info": {
"name": "Get Audio Podcast Series Metrics Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/podcast_series/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "Get all adgroups"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Audio podcast series metrics for a specific campaign."
},
{
"info": {
"name": "Get Audio Podcast Series Metrics Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/podcast_series/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Audio podcast series metrics for a specific adgroup."
},
{
"info": {
"name": "Get Campaign Recommendations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/recommendations/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Get recommendations for a specific campaign."
},
{
"info": {
"name": "Dismiss Recommendation",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/reporting/recommendations/campaign/:campaign_id/:recommendation_id/dismiss",
"params": [
{
"name": "recommendation_id",
"value": "",
"type": "path"
},
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Dismiss a recommendation"
},
{
"info": {
"name": "Apply Recommendation",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/reporting/recommendations/:recommendation_id/apply",
"params": [
{
"name": "recommendation_id",
"value": "",
"type": "path",
"description": "Recommendation ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query",
"description": "Tenant ID"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Apply a recommendation"
},
{
"info": {
"name": "Get Recommendation Count",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/reporting/recommendations/account/:account_id/count",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the recommendations count by campaign in an account"
},
{
"info": {
"name": "Get Foot Traffic Attribution",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/reporting/foot_traffic_attribution",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets foot traffic attribution report with visit and visitor metrics"
},
{
"info": {
"name": "Get Foot Traffic Attribution Detailed",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/reporting/foot_traffic_attribution/detailed",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets detailed foot traffic attribution report with visit and visitor metrics"
},
{
"info": {
"name": "Get Foot Traffic Attribution V2 Order Summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/foot_traffic_attribution/v2/order/:order_id/summary",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "This is the unique identifier which refers to a campaign."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD, default is current date"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD, default is current date"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets foot traffic attribution summary for a specific order"
},
{
"info": {
"name": "Get Foot Traffic Attribution V2 Detailed",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/foot_traffic_attribution/v2/order/:order_id/detailed",
"params": [
{
"name": "order_id",
"value": "",
"type": "path",
"description": "This is the unique identifier which refers to a campaign."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD, default is current date"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD, default is current date"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number (1-based)"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Number of items per page (max 1000)"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to return. If none are provided, all will be returned.
Available values:
- campaign_total_impressions
- campaign_identifiable_impressions
- observed_attributed_visits
- true_visits
- cumulative_visits"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets detailed foot traffic attribution report for a specific order"
},
{
"info": {
"name": "Get Fp Poitag Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/fp_poitag/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "fp_poitag",
"value": "",
"type": "query",
"description": "POI tag filter; omit for all tags (same as -1)."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, return metrics split by ad group."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets first-party POI tag breakdown metrics for a specific campaign."
},
{
"info": {
"name": "Get Fp Poitag Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/fp_poitag/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "fp_poitag",
"value": "",
"type": "query",
"description": "POI tag filter; omit for all tags (same as -1)."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets first-party POI tag breakdown metrics for a specific ad group."
},
{
"info": {
"name": "Get Mobile Category Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/mobile/category/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets mobile category metrics for a specific campaign."
},
{
"info": {
"name": "Get Mobile Category Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/mobile/category/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets mobile category metrics for a specific ad group."
},
{
"info": {
"name": "Get Mobile Category All Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/mobile/category/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets mobile category metrics for all ad groups in a specific campaign."
},
{
"info": {
"name": "Get Demographics Partial Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/demographics/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Filter of enabled metrics. Allowed: imp,vst,clks,ctr,rch,vcr,ltr. Provide at least one."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets campaign demographics (partial) metrics by gender and age"
},
{
"info": {
"name": "Get Age Gender Distribution Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/demographics/campaign/:campaign_id/age-gender-distribution",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, returns distribution grouped by ad group in addition to age and gender."
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets age-gender distribution metrics for a campaign (optionally by ad group)."
},
{
"info": {
"name": "Get Age Gender Distribution Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/demographic/adgroups/:adgroup_id/age_gender_distribution",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets age-gender distribution metrics for an ad group."
},
{
"info": {
"name": "Get Audience Affinity Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for a specific creative."
},
{
"info": {
"name": "Get Audience Category Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/category/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience category metrics for a specific campaign."
},
{
"info": {
"name": "Get Audience Affinity Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for a specific campaign."
},
{
"info": {
"name": "Get Brand Affinity Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/brand_affinity/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count per brand"
},
{
"name": "sic_code",
"value": "",
"type": "query",
"description": "Filter by SIC code"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets brand affinity (audience insights brand) metrics for a specific ad group."
},
{
"info": {
"name": "Get Brand Affinity Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/brand_affinity/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count per brand"
},
{
"name": "sic_code",
"value": "",
"type": "query",
"description": "Filter by SIC code"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets brand affinity (audience insights brand) metrics for a specific campaign."
},
{
"info": {
"name": "Get Brand Affinity Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/brand_affinity/campaigns/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count per brand"
},
{
"name": "sic_code",
"value": "",
"type": "query",
"description": "Filter by SIC code"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets brand affinity metrics for all adgroups in a campaign (export scope)."
},
{
"info": {
"name": "Get Brand Affinity Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/brand_affinity/campaigns/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count per brand"
},
{
"name": "sic_code",
"value": "",
"type": "query",
"description": "Filter by SIC code"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets brand affinity metrics for all creatives in a campaign (export scope)."
},
{
"info": {
"name": "Get Brand Affinity Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/brand_affinity/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count per brand"
},
{
"name": "sic_code",
"value": "",
"type": "query",
"description": "Filter by SIC code"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets brand affinity (audience insights brand) metrics for a specific creative."
},
{
"info": {
"name": "Get Imp Membership Breakdown Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/userinsight/imp/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Membership type: brand (1), category (2), or behaviour (3)."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets ad group-level impression membership breakdown (user insight): brand, category, or behaviour."
},
{
"info": {
"name": "Get Imp Membership Breakdown Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/userinsight/imp/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Membership type: brand (1), category (2), or behaviour (3)."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets campaign-level impression membership breakdown (user insight): brand, category, or behaviour."
},
{
"info": {
"name": "Get Audience Affinity Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for all adgroups in a campaign (export scope)."
},
{
"info": {
"name": "Get Audience Affinity Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for all creatives in a campaign."
},
{
"info": {
"name": "Get Audience Affinity Campaign V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/v2/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for a specific campaign."
},
{
"info": {
"name": "Get Audience Affinity Campaign Adgroups V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/v2/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for all adgroups in a specific campaign."
},
{
"info": {
"name": "Get Audience Affinity Creative V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/v2/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for a specific creative (v2)."
},
{
"info": {
"name": "Get Audience Affinity Campaign Creatives V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/v2/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for all creatives in a specific campaign."
},
{
"info": {
"name": "Get Audience Affinity Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for a specific adgroup."
},
{
"info": {
"name": "Get Audience Affinity Adgroup V2",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience_affinity/v2/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field. Allowed values are defined by AudienceAffinityFieldName (see schema)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "category_id",
"value": "",
"type": "query",
"description": "Filter by audience category ID"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience affinity metrics for a specific ad group (v2)."
},
{
"info": {
"name": "Get Audience Category Campaign All Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/category/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience category metrics for all ad groups in a specific campaign."
},
{
"info": {
"name": "Get Audience Category Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/category/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience category metrics for all creatives in a specific campaign."
},
{
"info": {
"name": "Get Audience Category Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/category/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience category metrics for a specific adgroup."
},
{
"info": {
"name": "Get Audience Category Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/category/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience category metrics for a specific creative."
},
{
"info": {
"name": "Get Audience V1 Breakdown Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/v1/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for brand, 2 for category"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience breakdown metrics for a specific campaign. (Old Taxonomy)"
},
{
"info": {
"name": "Get Audience V1 Breakdown Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/v1/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for brand, 2 for category"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience breakdown metrics for a specific ad group. (Old Taxonomy)"
},
{
"info": {
"name": "Get Audience V1 Breakdown Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/v1/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "1 for brand, 2 for category"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience breakdown metrics for a specific creative. (Old Taxonomy)"
},
{
"info": {
"name": "Get Audience Behavioral Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/behavioral/campaigns/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by: imp, clks, spend, ctr"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral audience (bhaud) metrics for all adgroups in a campaign."
},
{
"info": {
"name": "Get Audience Behavioral Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/behavioral/campaigns/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by: imp, clks, sa, ctr, vr"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impressions filter"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral audience (bhaud) metrics for all creatives in a campaign."
},
{
"info": {
"name": "Get Audience V2 Breakdown Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/v2/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience breakdown metrics for a specific campaign. (New Taxonomy)"
},
{
"info": {
"name": "Get Audience V2 Breakdown Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/v2/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience breakdown metrics for a specific ad group. (New Taxonomy)"
},
{
"info": {
"name": "Get Audience Behavioral Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/behavioral/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, returns metrics grouped by creative in addition to behavioral segment."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral audience (bhaud) metrics for a specific ad group (Rocket full + chart consolidated)."
},
{
"info": {
"name": "Get Audience Behavioral Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/behavioral/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field: imp, clks, sa, ctr, vr."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of records."
},
{
"name": "min_imp_count",
"value": "",
"type": "query",
"description": "Minimum impression count per segment (0 to include all; omit for default 5000)."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral audience (bhaud) metrics for a specific creative (Rocket AUDIENCE_INSIGHTS_BHAUD_CREATIVE)."
},
{
"info": {
"name": "Get Audience Segments Behavioral Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/segments/behavioral/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "bhaud",
"value": "",
"type": "query",
"description": "Filter to a single matched_baud / behavioral segment (backend key)."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field: imp, clks, spend, ctr."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of records."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral segment (bhaud) breakdown for an ad group (Rocket BhaudBreakdownByAdgroup)."
},
{
"info": {
"name": "Get Audience Segments Behavioral Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/segments/behavioral/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "bhaud",
"value": "",
"type": "query",
"description": "Filter to a single matched_baud / behavioral segment (backend key)."
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, breaks down by ad group plus segment (Rocket all_adgroups)."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field: imp, clks, spend, ctr."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of records."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral segment (bhaud) breakdown for a campaign (Rocket BhaudBreakdownByCampaign)."
},
{
"info": {
"name": "Get Audience Behavioral Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/behavioral/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, returns metrics grouped by ad group in addition to behavioral segment."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field: imp, clks, spend, ctr."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of records (export)."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets behavioral audience (bhaud) metrics for a specific campaign (Rocket full + chart + export consolidated)."
},
{
"info": {
"name": "Get Audience V2 Breakdown Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audience/v2/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audience breakdown metrics for a specific creative. (New Taxonomy)"
},
{
"info": {
"name": "Get Conversion Tracking Account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/conversion_tracking/account/:account_id",
"params": [
{
"name": "account_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "pixel_ids",
"value": "",
"type": "query",
"description": "Comma-separated list of pixel IDs"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets multipixel conversion metrics aggregated across all campaigns in an account."
},
{
"info": {
"name": "Get Pixel Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/pixel/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "pixel_ids",
"value": "",
"type": "query",
"description": "Comma-separated list of pixel IDs"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets multipixel conversions data for a specific campaign."
},
{
"info": {
"name": "Get Pixel Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/pixel/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets multipixel conversions export for a specific adgroup."
},
{
"info": {
"name": "Get Campaign Spend",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/spend/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets total up-to-date spend for a campaign."
},
{
"info": {
"name": "Get Adgroup Spend",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/spend/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets total up-to-date spend for an ad group."
},
{
"info": {
"name": "Get Marketshare Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/marketshare/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets market share data for a specific campaign."
},
{
"info": {
"name": "Get Audio Podcast Ad Position Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/podcast_ad_position/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio podcast ad position metrics for a specific campaign."
},
{
"info": {
"name": "Get Audio Podcast Ad Position Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/podcast_ad_position/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio podcast ad position metrics for all ad groups in a specific campaign."
},
{
"info": {
"name": "Get Audio Streaming Genre Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/streaming_genre/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio streaming genre metrics for a specific campaign."
},
{
"info": {
"name": "Get Audio Streaming Genre Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/streaming_genre/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio streaming genre metrics for a specific adgroup."
},
{
"info": {
"name": "Get Audio Streaming Genre Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/streaming_genre/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio streaming genre metrics for all adgroups in a specific campaign."
},
{
"info": {
"name": "Get Daily Metrics Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/daily/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries daily trend metrics for a specific campaign."
},
{
"info": {
"name": "Get Audio Publisher Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/publisher/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio publisher metrics for a specific campaign."
},
{
"info": {
"name": "Get Audio Publisher Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/publisher/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio publisher metrics for a specific adgroup."
},
{
"info": {
"name": "Get Audio Publisher Campaign All Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/audio/publisher/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets audio publisher metrics for all ad groups in a specific campaign."
},
{
"info": {
"name": "Get Daily Metrics Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/daily/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries daily trend metrics for a specific ad group."
},
{
"info": {
"name": "Get Daily Metrics Creative",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/daily/creative/:creative_id",
"params": [
{
"name": "creative_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries daily trend metrics for a specific creative."
},
{
"info": {
"name": "Get Ctv Publisher Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/publisher/v2/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV publisher metrics for a specific ad group."
},
{
"info": {
"name": "Get Ctv Publisher Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/publisher/v2/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV publisher metrics for a specific campaign."
},
{
"info": {
"name": "Get Ctv Publisher Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/ctv_ott/publisher/campaigns/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV/OTT publisher metrics for all ad groups in a campaign."
},
{
"info": {
"name": "Get Ctv Network Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/ctv_ott/network/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV/OTT network bundle metrics for a campaign (unified full/partial/export)."
},
{
"info": {
"name": "Get Ctv Network Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/ctv_ott/network/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV/OTT network bundle metrics per ad group for a campaign."
},
{
"info": {
"name": "Get Ctv Network Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/ctv_ott/network/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "sort_by",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets CTV/OTT network bundle metrics for an ad group."
},
{
"info": {
"name": "Get Daily Metrics Campaign Adgroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/daily/campaign/:campaign_id/adgroups",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries daily trend metrics for all ad groups in a specific campaign."
},
{
"info": {
"name": "Get Daily Metrics Campaign Creatives",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/daily/campaign/:campaign_id/creatives",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets timeseries daily trend metrics for all creatives in a specific campaign."
},
{
"info": {
"name": "Get Dooh Campaign V1",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/dooh/v1/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "cursor",
"value": "",
"type": "query",
"description": "Opaque cursor returned in `pagination.next_cursor`."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Number of rows per page (max 1000)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Alias for page_size."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "dimensions",
"value": "",
"type": "query",
"description": "Comma-separated list of dimensions to slice the campaign performance by. Order is preserved and duplicates collapsed.
Available values:
- publisher
- venue_type
- ad_group
- creative
- state
- dma
- county
- zip
- ad_unit_id"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Retrieves DOOH campaign performance grouped by requested dimensions. Supported dimensions include publisher, venue_type, state, county, dma, zip, ad_group, creative, and ad_unit_id."
},
{
"info": {
"name": "Get Dooh Publisher Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/dooh/publisher/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, breaks out results by ad group."
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, breaks out results by creative."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets DOOH publisher metrics for a specific campaign."
},
{
"info": {
"name": "Get Banner Size Breakdown Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/banner/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, breaks out results by creative."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets banner-size breakdown metrics for a specific ad group, optionally split by creative."
},
{
"info": {
"name": "Get Banner Size Breakdown Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/banner/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, breaks out results by ad group."
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, breaks out results by creative."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets banner-size breakdown metrics for a specific campaign, optionally split by ad group or creative."
},
{
"info": {
"name": "Get Dooh Venue Type Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/dooh/venue_type/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Date should be in YYYY-MM-DD"
},
{
"name": "all_adgroups",
"value": "",
"type": "query",
"description": "When true, breaks out results by ad group."
},
{
"name": "all_creatives",
"value": "",
"type": "query",
"description": "When true, breaks out results by creative."
},
{
"name": "sort_by",
"value": "",
"type": "query",
"description": "Sort by field"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit number of records"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets DOOH venue type metrics for a specific campaign."
},
{
"info": {
"name": "Get Web Engagement Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/web_engagement/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start date (YYYY-MM-DD). Must be provided with end_date."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End date (YYYY-MM-DD). Must be provided with start_date."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets daily trend web engagement metrics for a specific campaign."
},
{
"info": {
"name": "Get Web Engagement Totals Campaign",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/web_engagement/totals/campaign/:campaign_id",
"params": [
{
"name": "campaign_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start date (YYYY-MM-DD). Must be provided with end_date."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End date (YYYY-MM-DD). Must be provided with start_date."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets totals / cumulative web engagement metrics for a specific campaign."
},
{
"info": {
"name": "Get Web Engagement Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/web_engagement/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start date (YYYY-MM-DD). To override defaults, provide both start_date and end_date."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End date (YYYY-MM-DD). To override defaults, provide both start_date and end_date."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets daily trend web engagement metrics for a specific ad group."
},
{
"info": {
"name": "Get Web Engagement Totals Adgroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/reporting/web_engagement/totals/adgroup/:adgroup_id",
"params": [
{
"name": "adgroup_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Start date (YYYY-MM-DD). To override defaults, provide both start_date and end_date."
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "End date (YYYY-MM-DD). To override defaults, provide both start_date and end_date."
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets totals / cumulative web engagement metrics for a specific ad group."
}
]
},
{
"info": {
"name": "Search",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search Tenants",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/tenants",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches tenants"
},
{
"info": {
"name": "Search Organizations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/organizations",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches organizations"
},
{
"info": {
"name": "Search Accounts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/accounts",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches accounts"
},
{
"info": {
"name": "Search Campaigns",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/campaigns",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches campaigns"
},
{
"info": {
"name": "Search Adgroups",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/adgroups",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches ad groups"
},
{
"info": {
"name": "Search Creatives",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/creatives",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches creatives"
},
{
"info": {
"name": "Search Location Filters",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_filters",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches location filters"
},
{
"info": {
"name": "Search Audiences",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/audiences",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches audiences"
},
{
"info": {
"name": "Search Neighborhoods",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/neighborhoods",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches neighborhoods (behaviors, brands, categories, and location groups)"
},
{
"info": {
"name": "Search On Premise Locations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/on_premise_locations",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches on premise brands, categories, and location groups"
},
{
"info": {
"name": "Search Drive To Locations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/drive_to_locations",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches drive-to locations (brands and location groups)"
},
{
"info": {
"name": "Search Location Groups",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_groups",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches location groups for audience targeting"
},
{
"info": {
"name": "Search Ad Packages",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/ad_packages",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches ad packages"
},
{
"info": {
"name": "Search Pois Sources",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_groups/sources",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches sources to add to a location group"
},
{
"info": {
"name": "Search Pois Sources Count",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_groups/sources/count",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Returns counts for requested sources"
},
{
"info": {
"name": "Search Pois Sources Preview Pois",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_groups/sources/pois",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches POIs given requested sources"
},
{
"info": {
"name": "Search Pois Location Filters",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_groups/location_filters",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches location filters for a location group"
},
{
"info": {
"name": "Search Location Group Pois",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/search/location_groups/pois",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Searches POIs and addresses by business name and/or address"
}
]
},
{
"info": {
"name": "Static",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Account Verticals",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/account_verticals"
},
"docs": "Gets all account verticals"
},
{
"info": {
"name": "Get Audio Podcast Topics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/audio/podcast_topics"
},
"docs": "Gets all targetable audio podcast topics"
},
{
"info": {
"name": "Get Audio Streaming Genres",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/audio/streaming_genres"
},
"docs": "Gets all targetable audio streaming genres"
},
{
"info": {
"name": "Get Carriers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/mobile_carriers",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets all targetable carriers for your account's country"
},
{
"info": {
"name": "Get Cities",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/cities",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets all targetable cities for your account's country"
},
{
"info": {
"name": "Get Streaming Video Content Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/streaming_video/content_categories"
},
"docs": "Gets all targetable streaming video content categories"
},
{
"info": {
"name": "Get Streaming Video Premium Ctv Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/streaming_video/premium_ctv_categories"
},
"docs": "Gets all targetable CTV premium categories"
},
{
"info": {
"name": "Get Dmas",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/dmas"
},
"docs": "Gets all targetable DMAs"
},
{
"info": {
"name": "Get Publisher Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/publisher_categories"
},
"docs": "Gets all targetable publisher categories"
},
{
"info": {
"name": "Get States",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/states",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "account_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets all targetable states for your account's country"
},
{
"info": {
"name": "Get Iab Categories",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/iab_categories",
"params": [
{
"name": "search",
"value": "",
"type": "query",
"description": "Search IAB categories based on name or category"
}
]
},
"docs": "Gets IAB categories"
},
{
"info": {
"name": "Get Publishers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/static/publishers",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
},
{
"name": "campaign_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets available publishers for a campaign"
}
]
},
{
"info": {
"name": "Tenants",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Tenant",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/tenants/:tenant_id",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets a tenant"
},
{
"info": {
"name": "Update Tenant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/tenants/:tenant_id",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates a tenant"
}
]
},
{
"info": {
"name": "Upload",
"type": "folder"
},
"items": [
{
"info": {
"name": "Upload",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/upload",
"params": [
{
"name": "upload_type",
"value": "",
"type": "query"
}
],
"body": {
"type": "multipart-form",
"data": []
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Uploads a file and returns a URL"
}
]
},
{
"info": {
"name": "Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "Signup",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-public.groundtruth.com/users/signup",
"params": [
{
"name": "utm_source",
"value": "",
"type": "query"
},
{
"name": "utm_medium",
"value": "",
"type": "query"
},
{
"name": "utm_campaign",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new user, tenant, organization, and account"
},
{
"info": {
"name": "Get Current User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/users/current",
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets the current user"
},
{
"info": {
"name": "Get User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/users/:user_id",
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets a user"
},
{
"info": {
"name": "Update User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-public.groundtruth.com/users/:user_id",
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Updates a user"
},
{
"info": {
"name": "Delete User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-public.groundtruth.com/users/:user_id",
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Deletes a user"
},
{
"info": {
"name": "Get Users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/users",
"params": [
{
"name": "tenant_id",
"value": "",
"type": "query"
}
],
"auth": {
"type": "apikey",
"key": "x-gt-api-key",
"value": "{{x-gt-api-key}}",
"placement": "header"
}
},
"docs": "Gets users under a tenant"
}
]
},
{
"info": {
"name": "Miscellaneous",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Version",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-public.groundtruth.com/version"
},
"docs": "Gets the current API version"
}
]
}
],
"bundled": true
}