Skip to main content
Skip table of contents

StackAdapt

Overview

Vendor/Partner

StackAdapt

Version

GraphQL (specific version is not used in API calls)

API Documentation

https://docs.stackadapt.com/graphql (Requires login)

Sunset Date

None as of Sept. 2025

Channel(s)

Programmatic

Refresh Time (CST)

6am

Default backfill

7 Days

Alli Data Library

(tick)

Getting Started

Required Authorization

Getting an API key
  1. Locate the StackAdapt API key in the Data Support 1Pass vault.

  2. Reach out to support should you need an API key and not be able to locate one.

Authenticating the datasource with your API key

Save & Authorize your datasource

image-20250124-142739.png

Input your API key

image-20250924-195004.png

Upon saving the API key, the authorization will be available globally within the Alli client. You can customize the authorization access level by clicking the settings wheel in the Required Authorization section and selecting Only Me (Private) or Any user in <client>.

Define your Data

Dimensions

Name

ID

Type

Description

Start Date

start_date

date

Stats Start Time

End Date

end_date

date

Stats End Time

Advertiser ID

advertiser_id

string

The advertisers ID.

Advertiser Name

advertiser_name

string

The advertisers name.

Advertiser Deal IDs

advertiser_deal_ids

JSON

Advertiser Description

advertiser_description

JSON

A description of the advertiser.

Advertiser Domain Exclusions

advertiser_domain_exclusions

JSON

A list of website domains or URLs that the advertiser wants to exclude from their ad placements. Advertisers use these lists to control where their ads appear, to ensure they appear on those websites that best serve their brand image.

Advertiser Is Archived

advertiser_is_archived

string

True if the advertiser has been archived, false otherwise

Advertiser Is Inventory Package Strict

advertiser_is_inventory_package_strict

string

Indicates if the inventory package strict logic is applied.

Campaign Group ID

campaign_group_id

string

The Campaign Group ID.

Campaign Group Name

campaign_group_name

string

The name of the Campaign Group.

Campaign Group Budget Allocation Type

campaign_group_budget_allocation_type

string

The type of budget allocation for the Campaign Group.

Campaign Group Budget Min Budget Allocation Percentage

campaign_group_budget_min_budget_allocation_percentage

string

Custom daily budget % in integer (10% is 10) to be equally distributed among all campaigns in the campaign group. Remaining budget is spent according to the selected allocation type. Only applicable for Performance, Scale and Click-based.

Campaign Group Budget Unranked Campaigns Max Cap

campaign_group_budget_unranked_campaigns_max_cap

string

The maximum budget % in integer (10% is 10) allocated to unranked campaigns. Only applicable for Rank-based allocation. These campaigns will run as Scale-based.

Campaign Group Budget Rollover

campaign_group_budget_rollover

string

Roll over unspent budget to the next flight

Campaign Group Budget Type

campaign_group_budget_type

string

The way the budget for the group is measured and allocated, such as media cost, impressions, clicks, or revenue. The budget type can be selected by specifying the applicable enumeration of the CampaignGroupBudget type. See this object type for more details.

Campaign Group State

campaign_group_state

string

The condition of a Campaign Group after the user performs a certain action against that object.

Campaign Group Status

campaign_group_status

string

The condition of a Campaign Group after the system performs a certain action against that object.

Campaign Group Created At

campaign_group_created_at

string

Timestamp of the Campaign Group creation

Campaign Group Domain Exclusions

campaign_group_domain_exclusions

JSON

Specific internet domains that are intentionally left out or excluded from the inventory of all Campaigns associated with the Campaign Group.

Campaign Group Domains

campaign_group_domains

JSON

Internet domains where the ads of the Campaigns within the Campaign Group can be displayed.

Campaign Group Freq Cap Expiry

campaign_group_freq_cap_expiry

string

Duration of time in minutes before the limit expires.

Campaign Group Freq Cap Limit

campaign_group_freq_cap_limit

string

Limit of number of times a unique user can view the ad.

Campaign Group Is Archived

campaign_group_is_archived

string

True if the campaign group has been archived, false otherwise

Campaign Group Is Inventory Package Strict

campaign_group_is_inventory_package_strict

string

Indicates if the inventory package strict logic is applied.

Campaign Group Pacing Daily Spend Needed

campaign_group_pacing_daily_spend_needed

string

The daily spend needed.

Campaign Group Pacing Lifetime Budget

campaign_group_pacing_lifetime_budget

string

Lifetime budget.

Campaign Group Pacing Overall Pacing

campaign_group_pacing_overall_pacing

string

Overall pacing.

Campaign Group Pacing Total Projected Spend

campaign_group_pacing_total_projected_spend

string

Total projected spend.

Campaign Group Pacing Current Pace Percent Var

campaign_group_pacing_current_pace_percent_var

string

Current pace percent variance from daily spend needed.

Campaign Group Pacing Projected Daily Spend

campaign_group_pacing_projected_daily_spend

string

Projected daily spend.

Campaign Group Revenue Pricing

campaign_group_revenue_pricing

string

The expected amount of revenue that the group aims to generate. This value is used when setting up a campaign with a revenue budget type. If revenue type is MARGIN, then this value is the margin percentage (i.e the value 10 is 10%).

Campaign Group Revenue Type

campaign_group_revenue_type

string

The revenue type associated with the Campaign Group. This is an enumeration value of the CampaignGroupRevenue type, such as CPC, CPM, or MARGIN.

Campaign Group Timezone

campaign_group_timezone

string

The time zone of the Campaign Group.

Campaign ID

campaign_id

string

Campaign ID

Campaign Name

campaign_name

string

Campaign name

Campaign State

campaign_state

string

The condition of a campaign after the user performs a certain action against that object.

Campaign Status

campaign_status

string

The condition of a campaign after the system performs a certain action against that object.

Campaign Created At

campaign_created_at

string

Timestamp of the campaign creation

Campaign Freq Cap Expiry

campaign_freq_cap_expiry

string

Duration of time in minutes before the limit expires.

Campaign Freq Cap Limit

campaign_freq_cap_limit

string

Limit of number of times a unique user can view the ad.

Campaign Freq Min Expiry

campaign_freq_min_expiry

string

Duration of time in minutes before the limit expires. Always a multiple of 60 minutes.

Campaign Freq Cap Threshold

campaign_freq_min_threshold

string

Minimum of number of times a unique user should view the ad.

Campaign GA4 Enabled

campaign_ga_enabled

string

An indicator of whether the Google Analytics (GA) integration is enabled (true or false). This type of integration provides the ability to view all of the campaign statistics and metrics in one place, which can help optimize the campaign and improve its performance.

Campaign GA4 Web Property ID

campaign_ga_web_property_id

string

A unique identifier associated with a specific Google Analytics account. It is used to track and collect data from a particular website. The ID is typically a 9-digit number.

Campaign Goal Type

campaign_goal_type

string

A campaign goal guides the optimization and performance of your campaign. It sets a specific target that you want your campaign to achieve. This field specifies the goal type, such as a conversion or engagement.

Campaign Is Archived

campaign_is_archived

string

True if the campaign has been archived, false otherwise

Campaign Is Draft

campaign_is_draft

string

True if the campaign is a draft, false otherwise

Campaign Pacing Daily Spend Needed

campaign_pacing_daily_spend_needed

string

The daily spend needed.

Campaign Pacing Lifetime Budget

campaign_pacing_lifetime_budget

string

Lifetime budget.

Campaign Pacing Overall Pacing

campaign_pacing_overall_pacing

string

Overall pacing.

Campaign Pacing Total Projected Spend

campaign_pacing_total_projected_spend

string

Total projected spend.

Campaign Pacing Current Pace Percent Var

campaign_pacing_current_pace_percent_var

string

Current pace percent variance from daily spend needed.

Campaign Pacing Projected Daily Spend

campaign_pacing_projected_daily_spend

string

Projected daily spend.

Campaign Tactic Type

campaign_tactic_type

string

Creative tactic logic type

Campaign Timezone

campaign_timezone

string

Timezone

Campaign Updated At

campaign_updated_at

string

Timestamp of the last update

Ad ID

ad_id

string

Ad ID

Ad Name

ad_name

string

Ad name

Ad Brandname

ad_brandname

string

The name of the brand associated with the ad.

Ad Creative State

ad_creative_state

string

The condition of a creative after a user performs a certain action against that object. For example, PAUSED.

Ad Creative Status

ad_creative_status

string

The condition of a creative after a user performs a certain action against that object. For example, APPROVED.

Ad Impression Trackers

ad_impression_trackers

JSON

Impression tracker URLs

Ad Is Archived

ad_is_archived

string

True if the ad has been archived, false otherwise

Ad Is Draft

ad_is_draft

string

True if the ad is a draft, false otherwise

Ad Is Rejected

ad_is_rejected

string

True if the ad was rejected, false otherwise

Ad Paused

ad_paused

string

True if the ad is paused, false otherwise

Ad Reject Reasons

ad_reject_reasons

JSON

Reject reason

Metrics

Name

ID

Type

Description

Ad Serving

ad_serving

number

Ad Serving

App Install

app_install

number

App installs

ATOS

atos

number

Average time on site (seconds)

ATOS Units

atos_units

number

ATOS in readable units

Audio Completion Rate

audio_completion_rate

number

Listen-through rate, audio completions per audio starts

Audio Completions

audio_completions

number

95% audio completions

Audio Q1 Playbacks

audio_quartile_one_playbacks

number

25% audio completions

Audio Q2 Playbacks

audio_quartile_two_playbacks

number

50% audio completions

Audio Q3 Playbacks

audio_quartile_three_playbacks

number

75% audio completions

Audio Starts

audio_starts

number

Audio starts

Click Conversion Rate

click_conversion_rate

number

Click conversion rate

Click Conversions

click_conversions

number

Click conversions

Click Secondary Conversions

click_secondary_conversions

number

Click Secondary Conversions

Clicks

clicks

number

Clicks

Companion Banner Viewed

companion_banner_viewed

number

Companion banner viewed

Conversion Revenue

conversion_revenue

number

Conversion revenue

Conversions

conversions

number

Conversions

Cookie Conversions

cookie_conversions

number

Cookie conversions

cost

cost

number

Media cost

CPD Media Cost

cpd_media_cost

number

Cost per day

CTR

ctr

number

Click-through rate

CVR

cvr

number

Conversion rate

ECPA

ecpa

number

Effective cost per action

ECPC

ecpc

number

Effective cost per click

ECPCL

ecpcl

number

Effective cost per completed listen

ECPE

ecpe

number

Effective cost per engagement

ECPI

ecpi

number

Effective cost per impression

ECPM

ecpm

number

Effective cost per thousand impressions

ECPV

ecpv

number

Effective cost per view

Engagement Rate

engagement_rate

number

Engagements per impression

Engagements

engagements

number

Number of times 15 seconds was spent on the landing page

Enterprise Features

enterprise_features

number

Enterprise Features

Frequency

frequency

number

Impressions per unique impression

GA4 Average Session Duration

ga_average_session_duration

number

GA4 Average Session Duration

GA4 Bounce Rate

ga_bounce_rate

number

GA4 Bounce Rate

GA4 Engaged Sessions

ga_engaged_sessions

number

GA4 Engaged Sessions

GA4 Sessions

ga_sessions

number

GA4 Sessions

GA4 Total Users

ga_total_users

number

GA4 Unique Visits

Impression Conversion Rate

impression_conversion_rate

number

Impression conversion rate

Impression Conversions

impression_conversions

number

Impression conversions

Impression Secondary Conversions

impression_secondary_conversions

number

Imp Secondary Conversions

Impressions

impressions

number

Impressions

IP Conversions

ip_conversions

number

IP conversions

Margins

margins

number

margins

Measured Impressions

measured_impressions

number

Measured impressions

MMP Conversions

mmp_conversions

number

MMP conversions

MMP CPI

mmp_cpi

number

MMP cost per install

MMP Install

mmp_install

number

MMP installs

Page Starts

page_starts

number

Number of times page was loaded

Page Time Units

page_time_units

number

Page time in readable units

Profit

profit

number

Profit

RCPA

rcpa

number

Revenue cost per acquisition

RCPC

rcpc

number

Revenue cost per click

RCPCL

rcpcl

number

Revenue cost per completed listen

RCPCV

rcpcv

number

Revenue cost per completed view

RCPE

rcpe

number

Revenue cost per engagement

RCPM

rcpm

number

Revenue cost per mile

Revenue

revenue

number

Revenue

ROAS

roas

number

Return on ad spend

Secondary Conversions

secondary_conversions

number

Secondary conversions

SKAN Conversions

skan_conversions

number

SKAN Conversions

SKAN CPI

skan_cpi

number

SKAN cost per install

SKAN Install

skan_install

number

SKAN installs

SSP Revenue

ssp_revenue

number

SSP Revenue

Targeting

targeting

number

Targeting

Total Time

total_time

number

Total time spent on the page (seconds)

TP CPC Cost

tp_cpc_cost

number

Third-party CPC cost

TP CPM Cost

tp_cpm_cost

number

Third-party CPM cost

Unique Conversions

unique_conversions

number

Unique conversions

Unique ECPA

unique_ecpa

number

Unique effective cost per action

Unique Impressions

unique_impressions

number

Unique impressions

Video Completion Rate

video_completion_rate

number

Video completions per video start

Video Completions

video_completions

number

95% Video Completions

Video Q1 Playbacks

video_quartile_one_playbacks

number

25% video completions

Video Q2 Playbacks

video_quartile_two_playbacks

number

50% video completions

Video Q3 Playbacks

video_quartile_three_playbacks

number

75% video completions

Video Starts

video_starts

number

Video starts

View Rate

view_rate

number

Viewed impressions per measurable impression

Viewability Fee

viewability_fee

number

Viewability fee

Viewed Measured Impressions

viewed_measured_impressions

number

Viewed measured impressions

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.