Skip to main content
AdRoll logo
  • Category: marketing
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 51
  • Triggers: 0
  • Slug: ADROLL
  • Version: 20261101_00

Tools

Slug: ADROLL_CREATE_ADCreate an ad for an advertisable, optionally creating nested assets that do not have EIDs in the same operation.

Input Parameters

string
Display name of the ad; AdRoll requires fewer than 64 characters.
string ("facebook" | "native" | "web" | "html5" | "personalized" | "ad_network" | "linkedin" | "pinterest" | "tiktok" | "flash")
Type of the ad.
integer
Ad width in pixels.
array
Assets for the ad. Assets without an EID are created atomically with the ad.
integer
Ad height in pixels.
string
Initial status of the ad.
string ("LEADERBOARD" | "MEDIUM_RECTANGLE" | "WIDE_SKYSCRAPER" | "MOBILE_LEADERBOARD" | "LARGE_RECTANGLE" | "BILLBOARD" | "BANNER" | "SQUARE" | "SMALL_SQUARE" | "SKYSCRAPER" | "RECTANGLE" | "RECTANGLE_2" | "VERTICAL_BANNER" | "BUTTON" | "BUTTON_2" | "S300X100" | "S645X60" | "HALF_PAGE" | "HALF_BANNER" | "RECTANGULAR_BUTTON" | "MICRO_BANNER" | "SINGLE" | "CAROUSEL" | "VIDEO" | "NATIVE_AD_600x500" | "NATIVE_AD_600x315" | "NATIVE_AD_600x600" | "EMAIL_M_BANNER" | "EMAIL_BANNER" | "MAX_VIDEO" | "IDEA_PIN")
Subtype of the ad.
boolean
Whether the ad should be read-only.
boolean
Whether the ad is dynamic.
string
required
EID of the advertisable that will own the ad.
array
Parameters for a dynamic ad.
boolean
Whether AdRoll should avoid forwarding the ad.
integer
Zero for a single product and greater than zero for multiple products.
boolean
Whether the ad is multi-share optimized.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_ADGROUPCreate a web-retargeting adgroup under a Campaign v3 campaign.

Input Parameters

object
required
Exact Campaign v3 web-retargeting adgroup creation body.
string
required
Campaign EID under which to create the adgroup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_ADVERTISABLECreate an advertisable in an organization owned by the connected account.

Input Parameters

string
Advertisable website URL.
string
required
Name of the new advertisable.
string
ISO 3166-1 alpha-2 country code; omission applies AdRoll’s most conservative data policy.
string
required
EID of the organization that will own the advertisable; the connected account must own it.
boolean
Whether to make this the connected user’s default advertisable; defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_ASSETCreate an asset. File content is passed exactly as a base64 string in the JSON request body.

Input Parameters

string
Base64-encoded image content sent as a JSON string.
string
Display name of the asset.
string ("text" | "image" | "video")
Type of the asset.
string ("url" | "display_url" | "title" | "call_to_action" | "link_description" | "message" | "impression_tracker" | "third_party_click_tracker" | "instagram_permalink_url" | "object_story_id" | "brand_name" | "utm_tracking" | "preview_url" | "html" | "ad_blocker_url" | "tracking_urls" | "ad_text" | "fallback_type" | "actor_id" | "display_name" | "ad" | "logo" | "placeholder" | "default")
Asset subtype. Choose a text-specific value for text, an image-specific value for images, or the video-specific value for video.
string
Description of the asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_CAMPAIGNCreate a web-retargeting campaign under a Campaign v3 strategy.

Input Parameters

object
required
Exact Campaign v3 web-retargeting campaign creation body.
string
required
Strategy EID under which to create the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_MARKETPLACECreate a marketplace-to-merchant mapping. Both advertisables must be accessible and marketplace-enabled by AdRoll.

Input Parameters

string
required
Unique merchant identifier within the marketplace.
string
Merchant-owned identifier; must be unique for the same source advertisable.
string
required
EID of the merchant child advertisable.
string
required
EID of the marketplace parent advertisable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_RULECreate a pixel rule. AdRoll may normalize the requested order; use the returned value as authoritative. CRM-data rules require a CSV containing at least 100 emails, but the provider does not document its exact file encoding and header contract.

Input Parameters

string
Optional arbitrary rule name.
string ("c" | "s" | "p" | "b" | "l" | "u")
required
Rule type: c conversion, s segment, p prospect, b cart, l product list, or u product; it cannot be changed later.
integer
required
Requested priority hint within the pixel; lower numbers request higher priority. AdRoll may normalize this value, so use the returned order as authoritative.
string
required
EID of the pixel on which to create the rule.
string ("c" | "d" | "m")
Optional rule source: c cookie, d CRM data, or m mobile.
string
URL-matching expression for a URL rule.
object
A file the caller hands IN. s3key is an S3/R2 reference (production) or a base64 data: URL (self-hosted FILE_BACKEND=base64) — the FileStore knows which. Mirrors mercury/tools/files.py field-for-field.
integer
Inactivity duration before a user is dropped from the rule.
string
Optional display name.
string
Match method. URL rules default to the provider-required url_match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_SEGMENTCreate one audience segment for an advertiser and seed it with user identifiers.

Input Parameters

string
required
Human-readable segment name.
array
required
Initial user records to add.
string ("crm" | "custom" | "impression" | "user_events" | "user_attributes" | "crosschannel_lal")
required
Provider segment type appropriate for the supplied users and use case.
string
required
Advertiser EID that will own the segment.
integer
required
Number of days, from 1 through 540, that members remain valid.
boolean
Whether this is a conversion segment.
number
Conversion value associated with a conversion segment.
string ("customers" | "coworkers" | "competitors")
General-exclusion classification for an exclusion segment.
string
Salesforce company-list ID referenced by the segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_CREATE_STRATEGYCreate a Campaign v3 strategy under an advertisable.

Input Parameters

object
required
Exact Campaign v3 strategy creation body.
string
required
Advertisable EID under which to create the strategy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_DELETE_SEGMENTDelete one existing audience segment.

Input Parameters

string
required
EID of the segment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_EDIT_ADVERTISABLEEdit the name, URL, or country code of an accessible advertisable.

Input Parameters

string
New advertisable website URL.
string
New advertisable name.
string
New ISO 3166-1 alpha-2 country code.
string
required
EID of the advertisable to edit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_ADRetrieve an ad by its Ad API resource eid, not its Reporting adroll_ad_eid.

Input Parameters

string
required
Ad API resource EID returned as eid by CREATE_AD or LIST_ADS. Do not use adroll_ad_eid, which identifies the ad in Reporting GraphQL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_ADGROUPFetch one Campaign v3 adgroup by EID.

Input Parameters

string
required
EID of the adgroup to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_ADGROUP_GEOTARGETSFetch a Campaign v3 adgroup and return its geotargets. A missing or null geotarget field is returned as an empty list.

Input Parameters

string
required
EID of the adgroup whose geotargets to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_ADVERTISABLEFetch an advertisable by EID. AdRoll returns matching records as an array.

Input Parameters

string
required
EID of the advertisable to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_ADVERTISABLE_PIXELFetch the active pixel for an accessible advertisable.

Input Parameters

string
required
EID of the advertisable whose active pixel to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_ASSETRetrieve an asset by its EID.

Input Parameters

string
required
EID of the asset to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_CAMPAIGNFetch one Campaign v3 campaign by advertisable and campaign EID.

Input Parameters

string
required
EID of the campaign to retrieve.
string
required
Advertisable EID owning the requested campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_CURRENT_ORGANIZATIONReturn the connected account’s current organization from Reporting GraphQL, including nested advertisables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_MARKETPLACERetrieve marketplace mappings for a parent marketplace advertisable and child merchant advertisable. Both must be accessible and marketplace-enabled by AdRoll.

Input Parameters

string
required
EID of the merchant child advertisable.
string
required
EID of the marketplace parent advertisable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_PIXELFetch a pixel by EID.

Input Parameters

string
required
EID of the pixel to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_PIXEL_SEGMENTSFetch segments associated with a pixel. Composio always sends page 0 when omitted; per_page remains omitted unless supplied, preserving the provider’s unpaginated response behavior.

Input Parameters

integer
Current page number; Composio sends 0 when omitted.
string
Number of results per page; omit to request the unpaginated provider response.
string
required
EID of the pixel whose segments to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_RULEFetch a rule by EID, including its generated segments when returned.

Input Parameters

string
required
EID of the rule to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_RULE_SEGMENTSFetch the segments associated with a specific rule.

Input Parameters

string
required
EID of the rule whose segments to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_SEGMENTReturn one audience segment, optionally including general-exclusion attributes or an inactive segment.

Input Parameters

string
required
EID of the segment to retrieve.
boolean
Whether to include general-exclusion attributes in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_STRATEGYFetch one Campaign v3 strategy by EID.

Input Parameters

string
required
EID of the strategy to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_GET_XDEVICE_OPT_INRetrieve an accessible advertisable’s cross-device graph opt-in setting.

Input Parameters

string
required
EID of the advertisable whose cross-device setting to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_ADGROUPSReturn Reporting GraphQL adgroups for one campaign. Omitted collection filters preserve provider defaults; supplied filters constrain active state or included/excluded statuses.

Input Parameters

array
Return only adgroups with one of these provider statuses.
boolean
Return only adgroups matching this active state.
string
required
EID of the campaign whose adgroups to return.
array
Exclude adgroups with these statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_ADSRetrieve one numbered page of ads for an advertisable, or set all=‘true’ to request all matching ads. Omitted pagination inputs send page 1 with 10 records.

Input Parameters

string
Set to the string ‘true’ to return all ads. This can be slower than requesting numbered pages.
integer
Page number; Composio sends 1 when omitted.
string
Fields and directions to sort by, such as ‘eid’, ‘name desc’, or ‘name desc, eid’.
integer
Records per page; Composio sends 10 when omitted.
string
required
EID of the advertisable whose ads to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_ADVERTISABLESFetch one numbered page of advertisables associated with an organization; omitted pagination inputs send page 1 with 10 records.

Input Parameters

integer
One-based page number; Composio sends 1 when omitted.
integer
Number of advertisables to return; Composio sends 10 when omitted.
string
Organization EID; omit to use the connected user’s organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_ASSETSRetrieve one numbered page of assets belonging to an advertisable; omitted pagination inputs send page 1 with 10 records.

Input Parameters

integer
Page number; Composio sends 1 when omitted.
string
Fields and directions to sort by, such as ‘eid’, ‘name desc’, or ‘name desc, eid’.
integer
Records per page; Composio sends 10 when omitted.
string
required
EID of the advertisable whose assets to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_CAMPAIGNSReturn Reporting GraphQL campaigns for one advertisable. Omitted collection filters preserve provider defaults; supplied filters support state, classification, channel, source, funnel, objective, and tags.

Input Parameters

array
Return campaigns with these types.
array
Return campaigns from these sources.
array
Return campaigns on these channels.
array
Return only campaigns with one of these provider statuses.
array
Return campaigns with these ABM types.
boolean
Return only campaigns matching this active state.
array
Return campaigns with these use cases.
array
Return campaigns with these objectives.
array
Return campaigns with these tag prefixes.
array
Exclude campaigns with these types.
array
Return campaigns in these funnel stages.
string
required
EID of the advertisable whose campaigns to return.
array
Exclude campaigns from these sources.
array
Return campaigns with these targeting types.
array
Exclude campaigns on these channels.
array
Exclude campaigns with these statuses.
array
Exclude campaigns with these ABM types.
array
Exclude campaigns with these use cases.
array
Exclude campaigns in these funnel stages.
array
Exclude campaigns with these targeting types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_SEGMENTSReturn audience segments for an advertiser, optionally filtered by segment type.

Input Parameters

string
Comma-delimited response fields to omit. Omit this parameter to let AdRoll return its default field set.
string ("crm" | "custom" | "impression" | "user_events" | "user_attributes")
Optional documented filter: crm, custom, impression, user_events, or user_attributes.
string
required
Advertiser or advertisable EID whose segments to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_LIST_STRATEGIESReturn strategies for an advertisable. Cursor, paginate, and include_drafts are omitted unless supplied; the response has no pagination metadata.

Input Parameters

string
Provider cursor to send unchanged. The observed response exposes no continuation cursor.
boolean
Provider pagination switch; omitted when unset. No synthetic continuation is generated.
boolean
Whether to include draft strategies; omitted by Composio when unset.
string
required
Advertisable EID whose strategies to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_ADGROUPSQuery adgroups by campaign, advertisable, one EID, or many EIDs with nested relations and optional date/currency metrics.

Input Parameters

string
Single entity EID for by_eid mode.
array
Entity EIDs for by_eids mode.
string
ISO 4217 metrics currency.
string
Exclusive metrics end date.
array
Optional included statuses for parent lists; null preserves the provider collection default.
boolean
Optional active-state filter for parent lists; null preserves the provider collection default.
integer
Metrics over the previous N UTC days.
string
Parent EID for a parent-list mode.
string
Inclusive metrics start date.
string ("by_campaign" | "by_advertisable" | "by_eid" | "by_eids")
required
List adgroups by parent or look up one or many adgroup EIDs.
boolean
Include summary and daily performance metrics.
array
Exclude these adgroup statuses.
boolean
Include inactive nested audiences; Composio sends false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_ADSQuery ads by adgroup, advertisable, or Reporting EIDs (adroll_ad_eid from the Ad API), with optional date/currency metrics; parent lookup preserves adgroup relationship state.

Input Parameters

string
Reporting ad EID returned as adroll_ad_eid by the Ad API; required for by_eid mode.
array
Reporting ad EIDs returned as adroll_ad_eid by the Ad API; required for by_eids mode.
array
Include these ad types in parent-list modes.
integer
Filter by creative width.
integer
Filter by creative height.
string
ISO 4217 metrics currency.
string
Exclusive metrics end date.
array
Optional included statuses for parent lists; null preserves the provider collection default.
boolean
Optional active-state filter for parent lists; null preserves the provider collection default.
integer
Metrics over the previous N UTC days.
string
Parent EID for a parent-list mode.
string
Inclusive metrics start date.
string ("by_adgroup" | "by_advertisable" | "by_eid" | "by_eids")
required
List ads by parent or look up one or many ad EIDs.
boolean
Include summary and daily performance metrics.
string
Maximum creation timestamp, inclusive.
string
Maximum update timestamp, inclusive.
string
Minimum creation timestamp, inclusive.
string
Minimum update timestamp, inclusive.
boolean
Include inactive nested audiences; Composio sends false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_ADVERTISABLESQuery advertisables by user, organization, one EID, or many EIDs with nested relations and optional date/currency metrics.

Input Parameters

string
Single entity EID for by_eid mode.
array
Entity EIDs for by_eids mode.
string
ISO 4217 metrics currency.
string
Exclusive metrics end date.
array
Optional included statuses for parent lists; null preserves the provider collection default.
boolean
Optional active-state filter for parent lists; null preserves the provider collection default.
integer
Metrics over the previous N UTC days.
string
Parent EID for a parent-list mode.
string
Inclusive metrics start date.
string ("for_user" | "by_organization" | "by_eid" | "by_eids")
List the current user’s advertisables, list by organization, or look up EIDs.
boolean
Include summary and daily performance metrics.
boolean
Include inactive nested audiences; Composio sends false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_CAMPAIGNSQuery campaigns by advertisable, organization, one EID, or many EIDs with nested relations and optional date/currency metrics.

Input Parameters

string
Single entity EID for by_eid mode.
array
Entity EIDs for by_eids mode.
array
Include these campaign types.
array
Include these campaign sources.
array
Include these campaign channels.
string
ISO 4217 metrics currency.
string
Exclusive metrics end date.
array
Optional included statuses for parent lists; null preserves the provider collection default.
array
Include these ABM types.
boolean
Optional active-state filter for parent lists; null preserves the provider collection default.
integer
Metrics over the previous N UTC days.
array
Include these campaign use cases.
array
Include these objectives; supported only by by_advertisable.
string
Parent EID for a parent-list mode.
string
Inclusive metrics start date.
string ("by_advertisable" | "by_organization" | "by_eid" | "by_eids")
required
List campaigns by parent or look up one or many campaign EIDs.
array
Include campaigns with these tag prefixes.
array
Exclude these campaign types.
array
Include these funnel stages; supported only by by_advertisable.
array
Exclude these campaign sources.
boolean
Include summary and daily performance metrics.
array
Include these targeting types.
array
Exclude these campaign channels.
array
Exclude these campaign statuses.
array
Exclude these ABM types.
array
Exclude these campaign use cases.
array
Exclude these funnel stages; supported only by by_advertisable.
array
Exclude these targeting types.
boolean
Include inactive nested audiences; Composio sends false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_ORGANIZATIONSQuery the current AdRoll organization or organizations by one or many EIDs, including nested advertisables.

Input Parameters

string
Single entity EID for by_eid mode.
array
Entity EIDs for by_eids mode.
string
ISO 4217 metrics currency.
string
Exclusive metrics end date.
array
Optional included statuses for parent lists; null preserves the provider collection default.
boolean
Optional active-state filter for parent lists; null preserves the provider collection default.
integer
Metrics over the previous N UTC days.
string
Parent EID for a parent-list mode.
string
Inclusive metrics start date.
string ("current" | "by_eid" | "by_eids")
Lookup the current organization or organizations by EID.
boolean
Include summary and daily performance metrics.
boolean
Include inactive nested audiences; Composio sends false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_QUERYExecute one AdRoll Reporting GraphQL document and preserve complete or partial provider data, errors, request ID, and version.

Input Parameters

string
required
GraphQL query document to execute.
object
Variables referenced by the query document.
string
Operation name when the document contains multiple operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_REPORTING_SEGMENTSQuery direct segment metadata or parent-scoped campaign/adgroup audiences with relationship state and optional date-scoped audience-size metrics.

Input Parameters

string
Single entity EID for by_eid mode.
array
Entity EIDs for by_eids mode.
string
ISO 4217 metrics currency.
string
Exclusive metrics end date.
array
Optional included statuses for parent lists; null preserves the provider collection default.
boolean
Optional active-state filter for parent lists; null preserves the provider collection default.
integer
Metrics over the previous N UTC days.
string
Parent EID for a parent-list mode.
string
Inclusive metrics start date.
string ("by_advertisable" | "by_campaign" | "by_adgroup" | "by_eid" | "by_eids")
required
Query direct segment metadata or parent-scoped campaign/adgroup audiences. Use parent modes for relationship state and audience-size metrics.
boolean
Return only conversion or non-conversion segments in by_advertisable mode.
boolean
Include summary and daily performance metrics.
boolean
Include inactive nested audiences; Composio sends false when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_RUN_PERFORMANCE_REPORTReturn current AdRoll GraphQL delivery metrics for advertisables, campaigns, adgroups, or ads, optionally with attribution metrics, as an aggregate summary, aggregate daily rows, or per-entity summaries.

Input Parameters

string ("advertisable" | "campaign" | "adgroup" | "ad")
required
Entity level at which to report metrics.
array
Ad EIDs; required only for ad reports.
string
ISO 4217 currency for monetary metrics.
string
Exclusive report end date.
integer
Report over the previous N UTC days.
string
Inclusive report start date.
array
Adgroup EIDs; required only for adgroup reports.
string ("summary" | "date" | "entity")
Aggregate summary, aggregate daily rows, or one summary row per entity.
array
Campaign EIDs; required only for campaign reports.
array
Advertisable EIDs; required only for advertisable reports.
boolean
Include conversion and attribution metrics in addition to delivery metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_SEARCH_GEOTARGETSSearch AdRoll geotargets by a location-name prefix and optional types. Use count and page to iterate through results until an empty items list is returned.

Input Parameters

integer
Page number to request when matches exceed count. Increment page until AdRoll returns an empty results list.
integer
Maximum number of geotargets to return on each results page. Use with page to iterate until AdRoll returns an empty results list.
array
Geotarget types to include. AdRoll documents this query as a string enum while also requiring comma-delimited values; the list is sent as CSV.
string
Beginning of the geotarget location name to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_SET_CAMPAIGN_STATUSPause or activate one campaign through the Campaign v3 edit operation.

Input Parameters

string ("paused" | "active")
required
Desired delivery state: paused stops delivery and active maps to Campaign v3 live.
string
required
EID of the campaign whose delivery state to change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_UPDATE_ADGROUPEdit one web-retargeting or web-prospecting Campaign v3 adgroup.

Input Parameters

string
required
Exact Campaign v3 web-retargeting or web-prospecting adgroup edit body.
string
required
EID of the adgroup to edit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_UPDATE_CAMPAIGNEdit one Campaign v3 web-retargeting or web-prospecting campaign. Retargeting nested adgroups are inferred as create-or-edit by eid; prospecting nested adgroups must include eid.

Input Parameters

string
required
Exact Campaign v3 web-retargeting or web-prospecting campaign edit body.
string
required
EID of the campaign to edit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_UPDATE_SEGMENTUpdate audience-segment information and submit its user-record payload.

Input Parameters

string
required
Human-readable segment name shown in the AdRoll dashboard.
array
required
User records submitted in the segment update payload.
string
required
EID of the segment to update.
integer
New membership duration in days; omit to leave it unchanged.
number
New conversion value; omit to leave it unchanged.
string ("customers" | "coworkers" | "competitors")
New general-exclusion classification; omit to leave it unchanged.
string
New Salesforce company-list ID; omit to leave it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_UPDATE_STRATEGYEdit a Campaign v3 strategy containing only web-retargeting or web-prospecting campaigns using a complete campaign set. Existing campaigns omitted from the set are deleted; nested campaigns with an EID are edited, and new web-retargeting campaigns can be created.

Input Parameters

object
required
Exact Campaign v3 strategy edit body with the complete current campaign set. Campaigns omitted from that set are deleted, so campaigns is required on every call and must include every existing campaign to retain.
string
required
EID of the strategy to edit.
boolean
required
Confirm that the strategy contains only web-retargeting or web-prospecting campaigns and that strategy.campaigns is the complete set to retain. Mixed-channel strategies are not supported because the provider does not document social-channel campaign edit inputs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADROLL_UPDATE_XDEVICE_OPT_INUpdate an accessible advertisable’s cross-device graph opt-in setting; provider feature access is required.

Input Parameters

boolean
required
Whether the advertisable should opt into the cross-device graph.
string
required
EID of the advertisable whose cross-device setting to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not