Skip to main content
GET
Describe an integration provider

Authorizations

Authorization
string
header
required

Session token as Authorization: Bearer (the CLI and scripts).

Path Parameters

provider
enum<string>
required
Available options:
the_trade_desk,
amazon_dsp,
walmart_dsp,
beeswax,
google_dv360,
openx,
google_ad_manager,
google_ads,
meta,
tiktok,
snapchat,
x,
reddit,
openai_ads,
roku,
iqm,
yahoo_dsp,
mediamath,
linkedin,
pinterest

Response

The provider, its field specs, and its instructions

id
enum<string>
required
Available options:
the_trade_desk,
amazon_dsp,
walmart_dsp,
beeswax,
google_dv360,
openx,
google_ad_manager,
google_ads,
meta,
tiktok,
snapchat,
x,
reddit,
openai_ads,
roku,
iqm,
yahoo_dsp,
mediamath,
linkedin,
pinterest
Example:

"google_ads"

name
string
required
Example:

"Google Ads"

category
enum<string>
required
Available options:
dsp,
ssp,
wg
authMethod
enum<string>
required
Available options:
oauth,
credentials
availability
enum<string>
required

Whether integrations can be created here: available; not_configured when this platform lacks the OAuth application or developer token the provider needs; coming_soon for catalog placeholders

Available options:
available,
not_configured,
coming_soon
stage
enum<string>
required

available, or coming_soon for a catalog placeholder

Available options:
available,
coming_soon
settingsFields
object[]
required

What settings accepts on POST …/integrations and PATCH …/integrations/{id}; never secret

connectFields
object[]
required

What the connecting party enters: the body of POST …/integrations/{id}/credentials for a credentials provider; the fields asked before consent (POST …/integrations/{id}/oauth or the connect page) for an OAuth provider

instructions
string

Markdown shown to the connecting party

docsUrl
string