Audience API Reference

Note

If you use the APIs provided here, you are subject to the API Terms of Use

Note

We’ve introduced API keys, please read Migrating to API Keys

Description

AdRoll Audience API 1.0

Manage your segments with the AdRoll Audience API

Operations

GET /audience/v1/advertisers

Retrieve list of accessible advertisers

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

List of Advertiser IDs

Schema as JSON:

{
  "data": [
    {
      "advertiser_id": "string"
    }
  ]
}
Schema
Type

object

data

List of Advertiser IDs

Required

True

Type

array of items

POST /audience/v1/sharing/invitation

Send a Segment Sharing invitation. With an invitation, you are granting the other party the ability to use this your Segment on their Campaigns. The other party still needs to accept the invitation.

Parameters:

Query Parameters

Name

Required

Type

Description

segment_eid

True

string

EID of the Segment to share

advertisable_eid

True

string

EID of the Advertisable to share the Segment with

apikey

False

string

Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

An invitation

Returns SharingSegmentInvitationResponse

DELETE /audience/v1/sharing/invitation

Revoke an invitation. The other party will lose access to the shared Segment

Parameters:

Query Parameters

Name

Required

Type

Description

invitation_eid

True

string

EID of the invitation

apikey

False

string

Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

An invitation

Returns SharingSegmentInvitationResponse

Definitions

Duration

Number of days (1 to 540) members are valid in a segment

Type

integer

Maximum

540

Minimum

1

SegmentType

Represents the segment type

Type

string

Enum

crm, custom, impression, user_events, user_attributes, crosschannel_lal

SegmentGeneralExclusionType

Represents the general exclusion type

Type

string

Enum

customers, coworkers, competitors

SegmentSfdcCompanyListId

Represents the salesforce company list id that this segment references

Type

string

SegmentResponse
Type

object

segment_id

Identifier used to represent this segment

Required

True

Type

string

type
Required

True

Type

SegmentType

name

Name given to the segment upon creation

Required

True

Type

string

duration
Type

Duration

emails

Number of emails appended to a crm segment

Type

integer

Format

int64

ids

Number of users appended to a custom segment

Type

integer

Format

int64

is_conversion

true if a segment is a conversion segment else false

Type

boolean

conversion_value

conversion value associated with the conversion segment else null

Type

number

Format

float

general_exclusion_type
Type

SegmentGeneralExclusionType

sfdc_company_list_id
Type

SegmentSfdcCompanyListId

WarehouseResponse
Type

object

id
Type

integer

advertiser_id
Type

string

db_username
Type

string

db_password
Type

string

Format

binary

db_name
Type

string

db_port
Type

integer

db_host
Type

string

db_schema
Type

string

db_type
Type

string

is_active
Type

boolean

created_date
Type

integer

warehouse_eid
Type

string

comments
Type

string

email_opt_in
Type

boolean

UserRecord
Type

object

email

Email RFC 5322 standard. Used with crm segments.

Type

string

id

Unique user identifier synced to AdRoll via Cookie Match. Used with custom segments.

Type

string

SegmentCreate
Type

object

advertiser_id

ID of the advertiser to create a new segment for

Required

True

Type

string

type
Required

True

Type

SegmentType

name

Name given to the segment upon creation

Required

True

Type

string

duration
Required

True

Type

Duration

data

User records to add

Required

True

Type

array of UserRecord

is_conversion

true if a segment is a conversion segment

Type

boolean

conversion_value

new conversion value to be associated with the conversion segment

Type

number

Format

float

general_exclusion_type
Type

SegmentGeneralExclusionType

sfdc_company_list_id
Type

SegmentSfdcCompanyListId

SegmentUpdate
Type

object

name

Name shown on client’s dashboard

Required

True

Type

string

duration
Type

Duration

data

User records to add

Required

True

Type

array of UserRecord

conversion_value

new conversion value to be associated with the existing conversion segment

Type

number

Format

float

general_exclusion_type
Type

SegmentGeneralExclusionType

sfdc_company_list_id
Type

SegmentSfdcCompanyListId

AdvertisableAttributes
Type

object

attributes

List or detailed list of user attributes from an advertisable

Type

array of AdvertisableAttributesDetail

AdvertisableAttributesDetail
Type

object

name
Type

string

AdvertisableAttributeSourceNameList

List of attribute source names the advertisable may use

Type

array

AdvertisableAttributeSourceMap

mapping from attribute source name to its definition

Type

object

AdvertisableAttributeMap
Type

object

is_internal

if true, the source is managed/populated internally

Type

boolean

description
Type

string

attributes
Type

AdvertisableAttributeCategoryMap

AdvertisableAttributeCategoryMap

mapping from attribute category name to its contents

Type

object

AdvertisableAttributeOrderKey

any value which can be sorted, representing an optional presentation ordering key

Type

object

AdvertisableAttributeCategory

a nested grouping of attribute values

Type

object

singular

if true, selection of enumerable member values should be exclusive

Type

boolean

description
Type

string

order_key
Type

AdvertisableAttributeOrderKey

attributes
Type

AdvertisableAttributeCategoryMap

values
mapping from attribute values to metadata about them. keys may be user-facing.
Type

object

AdvertisableAttributeValueDetail

metadata about a single attribute value

Type

object

id

unique integer or opaque string identifier of the attribute

Type

object

order_key
Type

AdvertisableAttributeOrderKey

description

user-facing extended description of the attribute

Type

string

non_enumerable

if true, the attribute is non-enumerable (string-valued)

Type

boolean

target
"name" value which should appear in targeting rules referencing this attribute
Type

string

UserAttributeCountsRequestAttributes
Type

object

UserAttributeCountsRequest
Type

object

attributes
Type

UserAttributeCountsRequestAttributes

UserAttributeCountsRequestResult
Type

object

UserAttributeCountsResponse
Type

object

results
Type

UserAttributeCountsRequestResult

SegmentGeneralExclusionResponse
Type

object

results
Type

SegmentResponse

SegmentsWithSizesResponse

Represents a segment with their audience sizes (facebook and audiences)

Type

object

total_visitors

Number of total visitors

Type

integer

Format

int64

facebook_visitors

Number of facebook visitors

Type

integer

Format

int64

CrossChannelLalValidSegments

List of valid and invalid segments to be used as CrossChanel lal Segments

Type

object

advertiser_id

ID of the advertiser to create a new segment for

Type

string

invalid_segments

Segments of valid type but that doesn’t meet audience sizes requirements

Type

array of SegmentsWithSizesResponse

valid_segments

Segments of valid type and that meets audience sizes requirements

Type

array of SegmentsWithSizesResponse

prospecting_only_valid_segments

Segments of valid type and that meets audience sizes only for prospecting

Type

array of SegmentsWithSizesResponse

TargetAccountsListAllResponse

All Target Accounts Lists response

Type

object

results

An array of Target Accounts Lists

Type

array of TargetAccountsList

TargetAccountsList

The Target Accounts Lists (TAL)

Type

object

eid

The Target Accounts List EID

Type

string

name

The Target Accounts List name

Type

string

advertisable_eid

The advertisable EID that owns this TAL

Type

string

updated_at

The last timestamp of when this TAL was updated

Type

string

Format

date-time

updated_by_user_at

The last timestamp of when this TAL was updated by some user

Type

string

Format

date-time

updated_by_user_eid

The last user that updated this TAL

Type

string

scoring_model_id

The production scoring model ID

Type

string

scoring_status

The current status of the entire scoring process

Type

string

scoring_production_model_id

The production scoring model ID

Type

string

scoring_production_status

The current status of the production scoring process

Type

string

scoring_production_retries

The number of retries for the production scoring model

Type

integer

scoring_holdout1_model_id

The holdout 1 scoring model ID

Type

string

scoring_holdout1_status

The current status of the holdout 1 scoring process

Type

string

scoring_holdout1_retries

The number of retries for the holdout 1 scoring model

Type

integer

scoring_holdout2_model_id

The holdout 2 scoring model ID

Type

string

scoring_holdout2_status

The current status of the holdout 2 scoring process

Type

string

scoring_holdout2_retries

The number of retries for the holdout 2 scoring model

Type

integer

scoring_holdout3_model_id

The holdout 3 scoring model ID

Type

string

scoring_holdout3_status

The current status of the holdout 3 scoring process

Type

string

scoring_holdout3_retries

The number of retries for the holdout 3 scoring model

Type

integer

scoring_holdout4_model_id

The holdout 4 scoring model ID

Type

string

scoring_holdout4_status

The current status of the holdout 4 scoring process

Type

string

scoring_holdout4_retries

The number of retries for the holdout 4 scoring model

Type

integer

scoring_holdout5_model_id

The holdout 5 scoring model ID

Type

string

scoring_holdout5_status

The current status of the holdout 5 scoring process

Type

string

scoring_holdout5_retries

The number of retries for the holdout 5 scoring model

Type

integer

scoring_filename

The filename that generated the scoring model

Type

string

scoring_items_count

The number of items used for the scoring process

Type

integer

scoring_items_pending

Flag that signals that there are pending items to be scored

Type

boolean

scoring_at

The timestamp of when the scoring process was started

Type

string

Format

date-time

scoring_by_user_eid

The user that started the scoring process

Type

string

scoring_auc

The raw number for the score AUC (Area Under the Curve)

Type

number

scoring_grades
Type

TargetAccountsScoringGrades

sfdc_sync_state

The configuration for the Salesforce synchronization

Type

string

Enum

none, push, bidirectional

sfdc_company_list_object_id

The Salesforce Company List ID that syncs with this TAL

Type

string

sfdc_company_list_name

The Salesforce Company List name that syncs with this TAL

Type

string

sfdc_scoring_company_list_object_id

The Salesforce Company List ID used for scoring model

Type

string

sfdc_scoring_company_list_name

The Salesforce Company List name used for scoring model

Type

string

sfdc_synced_at

The last timestamp of the Salesforce synchronization

Type

string

Format

date-time

items_count

The number of items in the Target Accounts List

Type

integer

suggestions_count

The number of suggestions in the Target Accounts List

Type

integer

tiers

An array of Target Accounts Tier

Type

array of TargetAccountsTier

TargetAccountsScoringGrades

The Target Accounts List grades scoring configuration

Type

object

A
Type

TargetAccountsScoringGrade

B
Type

TargetAccountsScoringGrade

C
Type

TargetAccountsScoringGrade

D
Type

TargetAccountsScoringGrade

F
Type

TargetAccountsScoringGrade

scored_count

The number of scored items in the Target Accounts List

Type

integer

unscored_count

The number of unscored items in the Target Accounts List

Type

integer

TargetAccountsScoringGrade

The Target Accounts List grade definition

Type

object

threshold
Type

integer

min_item

The Target Accounts List grade minimum item in this grade

Type

object

items_count

The number of scored items in this grade

Type

integer

TargetAccountsScoringGradesUpdate

The Target Accounts List grades scoring configuration

Type

object

A
Type

TargetAccountsScoringGradeUpdate

B
Type

TargetAccountsScoringGradeUpdate

C
Type

TargetAccountsScoringGradeUpdate

D
Type

TargetAccountsScoringGradeUpdate

F
Type

TargetAccountsScoringGradeUpdate

TargetAccountsScoringGradeUpdate

The Target Accounts List grade definition

Type

object

threshold
Type

integer

TargetAccountsTier

The Target Accounts Tier

Type

object

tal_eid

The Target Accounts List EID this tier belongs to

Type

string

eid

The EID of the tier or one of the calculated tiers: all and untiered

Type

string

name

The name of the tier

Type

string

items_count

The number of items in this tier

Type

integer

created_at

The creation timestamp of the tier

Type

string

Format

date-time

TargetAccountsTiersCreateBase

The Target Accounts Tier

Type

object

name

The name of the tier

Required

True

Type

string

domains
Required

True

Type

array of items

TargetAccountsTierCreate
TargetAccountsTierUpdate

The Target Accounts Tier updatable fields

Type

object

eid

The tier EID

Required

True

Type

string

name

The name of the tier

Required

True

Type

string

TargetAccountsListCreateBase

Create a Target Accounts List

Type

object

advertisable_eid
Required

True

Type

string

name
Required

True

Type

string

domains
Type

array of items

source
Type

string

Enum

user_uploaded, discover_accounts, suggestion, sfdc_synced, notification

TargetAccountsListCreate
TargetAccountsListUpdate

Update a Target Accounts List

Type

object

eid

The Target Accounts List EID

Required

True

Type

string

name

The Target Accounts List name

Type

string

scoring_status
Type

string

scoring_production_status
Type

string

scoring_holdout1_status
Type

string

scoring_holdout2_status
Type

string

scoring_holdout3_status
Type

string

scoring_holdout4_status
Type

string

scoring_holdout5_status
Type

string

scoring_auc
Type

number

scoring_grades
Type

TargetAccountsScoringGradesUpdate

scoring_items_pending
Type

boolean

sfdc_sync_state

The configuration for the Salesforce synchronization

Type

string

Enum

none, push, bidirectional

sfdc_synced_at

The last timestamp of the Salesforce synchronization

Type

string

Format

date-time

NumericAttributeFilter

Filter for Company Attributes numeric field

Type

object

from
Type

integer

to
Type

integer

DomainReferencesRequest

Options for domain references

Type

object

domains

Domains to query

Required

True

Type

array of items

entities

Entities to query

Type

array of items

verbose

Whether to include extra entity information

Type

boolean

DomainReferencesResponseVerboseEntity
Type

object

eid
Type

string

name
Type

string

DomainReferencesResponseDomain
Type

object

companies
Type

DomainReferencesResponseVerboseEntity

target_accounts
Type

DomainReferencesResponseVerboseEntity

playbooks
Type

DomainReferencesResponseVerboseEntity

DomainReferencesResponse
Type

object

results
Type

object

TargetAccountsTiersAllResponse

All Target Accounts Tiers response

Type

object

results

An array of Target Accounts Tier

Type

array of TargetAccountsTier

TargetAccountItemsFilter

Filter Target Accounts Items

Type

object

is_scored

Filter only items that are scored

Type

boolean

score
Type

NumericAttributeFilter

grades

Filter only items that are in the given grades

Type

array of items

TargetAccountsItemsAllResponse

All Target Accounts Items response

Type

object

results

An array of Target Accounts Items

Type

array of TargetAccountsItemsReport

total_items
Type

integer

TargetAccountsItems

Target Accounts Item

Type

object

domain
Type

string

score
Type

number

source
Type

string

Enum

user_uploaded, discover_accounts, suggestion, sfdc_synced, notification

sfdc_synced_at

The last timestamp of the Salesforce synchronization

Type

string

Format

date-time

updated_at
Type

string

Format

date-time

TargetAccountsItemsReport
TargetAccountsItemsUpdate

Target Accounts Item

Type

object

domain
Type

string

score
Type

number

source
Type

string

Enum

user_uploaded, discover_accounts, suggestion, sfdc_synced, notification

sfdc_synced_at

The last timestamp of the Salesforce synchronization

Type

string

Format

date-time

TargetAccountsItemsListUpdate

A list of Target Accounts Items to update

Type

object

items
Type

array of TargetAccountsItemsUpdate

TargetAccountsItemsListDelete

A list of Target Accounts domains to delete

Type

object

domains
Type

array of items

inverted

Tells if domains is the oposite selection in the current TAL/TAG

Type

boolean

filters
Type

TargetAccountItemsFilter

force

Force the deletion even though there are audiences associated with this item

Type

boolean

TargetAccountsItemsSearch

Search Target Accounts List items

Type

object

domains
Type

array of items

inverted

Tells if domains is the oposite selection in the current TAL/TAG

Type

boolean

filters
Type

TargetAccountItemsFilter

SegmentTalReferences

A TAL segment reference

Type

object

advertisable_eid
Type

string

eid
Type

string

type
Type

string

name
Type

string

tal_eid
Type

string

tal_tier_eid
Type

string

created_date
Type

string

Format

date-time

last_modified_date
Type

string

Format

date-time

rule_last_modified_date
Type

string

Format

date-time

cdp_rule_eid
Type

string

SegmentTalReferencesResponse

All TAL references of a segment

Type

object

results

An array of TAL references

Type

array of SegmentTalReferences

UserAttributeSegmentResponse

Represents a user attribute segment

Type

object

display_name
Type

string

name
Type

string

comparator
Type

string

values
Type

array of items

source
Type

string

UserAttributesSegmentResponse

Represents many user attributes

Type

object

attributes
Type

array of UserAttributeSegmentResponse

use_first_party_data
Type

boolean

use_third_party_data
Type

boolean

attributes_source
Type

string

tal_eid
Type

string

tal_tier_eid
Type

string

cdp_rule_eid
Type

string

SharingSegmentMirrorSegmentResponse

Represents a Mirror Segment

Type

object

advertisable_eid

The Advertisable owning the Segment.

Type

string

eid

The eid of the segment

Type

string

name

The name of the segment

Type

string

source_segment_eid

The EID of the Segment that was shared.

Type

string

segment_source

Where the source segment is stored.

Type

string

SharingSegmentInvitationResponse

Represents a Segment Invitation

Type

object

source_user_eid

The user than sent the invitation.

Type

string

source_segment_eid

The EID of the Segment that wants to be shared.

Type

string

source_advertisable_eid

The Advertisable sharing the Segment.

Type

string

target_advertisable_eid

The Advertisable receiving the Segment Share invitation.

Type

string

accepted

Has the invitation been accepted?

Type

boolean

is_active

Whether or not the invitation is still active.

Type

boolean

segment_source
Type

string

created_at

When this invitation was sent.

Type

string

Format

date-time

updated_at

When this invitation was updated (accepted/deleted).

Type

string

Format

date-time

SharingSegmentInvitationListResponse
Type

array

SharingSegmentBulkSegmentCreateResponse

Represents the results of a bulk creation

Type

object

created_segments

Successful creations count

Type

integer

failed_creations

failed creations count, usually due to invitation already being accepted

Type

integer

CDP-Segment-Create-Input

Parameters when sending a POST request to create a CDP Segment.

Type

object

advertisable_eid

Advertisable EID of the segment.

Required

True

Type

string

display_name

Display name of the segment.

Required

True

Type

string

predictive_rule

Rules defining a predictive audience

Type

object

event_rule

Rules defining the events belonging to the users that populate this segment.

Type

object

user_rule

Rules defining the users that populates this segment.

Type

object

CDP-Segment-Update-Input

Parameters when sending a POST request to update a CDP Segment.

Type

object

display_name

Display name of the segment.

Type

string

CDP-Segment-Response

Response of a CDP Segment.

Type

object

advertisable_eid

Advertisable EID of the segment.

Type

string

display_name

Display name of the segment.

Type

string

predictive_rule

Rules defining a predictive audience

Type

object

event_rule

Rules defining the events belonging to the users that populate this segment.

Type

object

user_rule

Rules defining the users that populates this segment.

Type

object

eid

The EID of the CDP Segment

Type

string

segment_size

The number of users (emails) in the CDP segment within the segment’s recency window.

Type

integer

is_active

Whether or not the segment is active.

Type

boolean

first_process_date

When this segment was first processed and populated.

Type

string

Format

date-time

last_process_date

When this segment was last processed and populated.

Type

string

Format

date-time

created_at

When this segment was created.

Type

string

Format

date-time

updated_at

When this segment was last updated.

Type

string

Format

date-time

segmentation_type

Type of segmentation.

Type

string

Enum

EVENT_AND_USER, USER_ONLY, EVENT_ONLY

CDP-Segment-Get-Email
Type

object

segment_eids

List of segment eids to get emails from

Required

True

Type

array of items

excluded_segment_eids

List of segment eids to not get emails from

Type

array of items

max_page_size

Total amount of emails to return per page, defaults to 20000

Type

integer

next_page_token

The last hashed email returned, used to get the starting point for pagination

Type

string

CDP-Segment-Get-Email-Response
Type

object

emails

List of md5 hashed emails

Required

True

Type

array of items

next_page_token

The last hashed email returned, used to get the starting point for pagination

Required

True

Type

string

CDP-Segments-Manual-Population

Parameters when sending a POST request to create a CDP Segment.

Type

object

segments_users_pairs

List of segment -> emails profiles to be added.

Required

True

Type

array of items

ICPAttributeFilters
Type

array

ICPDataTypeFilters
Type

array

ICPFilterBlocks
Type

array

ICPAttributes

Attributes based on the most common third-party company attributes from the accounts in the positive_domains list.

Type

object

country
Type

array of items

industry
Type

array of items

revenue
Type

array of items

size
Type

array of items

ICPDetails
Type

object

updated_at
Type

string

updated_by_user_eid
Type

string

Format

nullable

attributes

List or detailed list of user attributes from an advertisable

Type

array of ICPAttributes

model_status
Type

string

advertisable_eid
Type

string

deleted_at
Type

string

Format

nullable

eid
Type

string

model_updated_at
Type

string

created_by_user_eid
Type

string

Format

nullable

deleted_by_user_eid
Type

string

Format

nullable

model_uuid
Type

string

positive_domains
Type

array of items

last_completed_model_uuid
Type

string

selected_picture_key
Type

string

name
Type

string

created_at
Type

string

domain_filter_settings
Type

object

ICPDetailsList
Type

object

icps
Type

array of ICPDetails

ICPAccountsFilter
Type

object

eid
Type

string

comparator
Type

string

Enum

exists, in, not_in

grades
Type

string

Enum

A, B, C, D, F

ICPAccountsRequest
Type

object

icp_filters
Type

array of ICPAccountsFilter

domains
Type

object

after
Type

string

size
Type

integer

ICPAccountsResponse
Type

object

page_info
Type

object

results
Type

array of items

total_count
Type

integer

Format

int32

ICPScoreList
Type

object

results
Type

array of items