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 by Tag¶

Target Account Lists¶

GET /audience/v1/target_accounts
POST /audience/v1/target_accounts
GET /audience/v1/target_accounts/names
GET /audience/v1/target_accounts/(tal_eid)
POST /audience/v1/target_accounts/(tal_eid)
DELETE /audience/v1/target_accounts/(tal_eid)
GET /audience/v1/target_accounts/(tal_eid)/tiers
POST /audience/v1/target_accounts/(tal_eid)/tiers
GET /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)
DELETE /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)
GET /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
PUT /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
DELETE /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items/delete
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items/filter

Untagged¶

GET /audience/v1/advertisers
GET /audience/v1/crosschannel_lal_segments/valid-segments
GET /audience/v1/ideal_customer_profile
POST /audience/v1/ideal_customer_profile
POST /audience/v1/ideal_customer_profile/accounts
GET /audience/v1/ideal_customer_profile/all_scores
GET /audience/v1/ideal_customer_profile/(icp_eid)
POST /audience/v1/ideal_customer_profile/(icp_eid)
DELETE /audience/v1/ideal_customer_profile/(icp_eid)
GET /audience/v1/segments
POST /audience/v1/segments
POST /audience/v1/segments/bulk
GET /audience/v1/segments/general_exclusions
GET /audience/v1/segments/tal_references
PUT /audience/v1/segments/tal_references
GET /audience/v1/segments/(segment_id)
POST /audience/v1/segments/(segment_id)
DELETE /audience/v1/segments/(segment_id)
POST /audience/v1/segments_bulk/put
GET /audience/v1/sharing/get_source_segment
GET /audience/v1/sharing/invitation
POST /audience/v1/sharing/invitation
DELETE /audience/v1/sharing/invitation
POST /audience/v1/sharing/segment
DELETE /audience/v1/sharing/segment
GET /audience/v1/target_accounts
POST /audience/v1/target_accounts
POST /audience/v1/target_accounts/domain_references
GET /audience/v1/target_accounts/domains
GET /audience/v1/target_accounts/general_exclusions
GET /audience/v1/target_accounts/names
GET /audience/v1/target_accounts/(tal_eid)
POST /audience/v1/target_accounts/(tal_eid)
DELETE /audience/v1/target_accounts/(tal_eid)
GET /audience/v1/target_accounts/(tal_eid)/tiers
POST /audience/v1/target_accounts/(tal_eid)/tiers
GET /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)
DELETE /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)
GET /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
PUT /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
DELETE /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items/delete
POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items/filter
POST /audience/v1/user_attribute_counts
GET /audience/v1/user_attribute_names/(advertisable_eid)

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 object

GET /audience/v1/crosschannel_lal_segments/valid-segments¶

Retrieve a list of valid and invalid segments for crosschannel lal targeting

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
`advertiser_id`	True	string	Advertisable eid to retrieve list of valid segments

Responses:

200

List of valid/invalid segments for crosschannel targeting

Returns CrossChannelLalValidSegments

GET /audience/v1/ideal_customer_profile¶

Retrieves a list of ICP by advertisable EID.

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
`advertisable_eid`	True	string	Advertisable EID

Responses:

200

Success

Returns ICPDetailsList

POST /audience/v1/ideal_customer_profile¶

Creates an ICP by advertisable EID.

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
`advertisable_eid`	True	string	Advertisable EID

Schema for request body: ICPDetails

{
  "advertisable_eid": "string",
  "attributes": [
    {
      "country": [
        "string"
      ],
      "industry": [
        "string"
      ],
      "revenue": [
        "string"
      ],
      "size": [
        "string"
      ]
    }
  ],
  "created_at": "string",
  "created_by_user_eid": "string",
  "deleted_at": "string",
  "deleted_by_user_eid": "string",
  "domain_filter_settings": {
    "filterBlocks": [
      {
        "dataTypeFilters": [
          {
            "attributeFilters": [
              {
                "attributeDisplayName": "string",
                "attributeName": "string",
                "comparator": "string",
                "from": "string",
                "to": "string",
                "type": "string",
                "uniqueKey": "string",
                "values": [
                  {
                    "displayValue": "string",
                    "value": "string"
                  }
                ]
              }
            ],
            "key": "string",
            "object": "string",
            "source": "string",
            "type": "string"
          }
        ],
        "key": "string"
      }
    ]
  },
  "eid": "string",
  "last_completed_model_uuid": "string",
  "model_status": "string",
  "model_updated_at": "string",
  "model_uuid": "string",
  "name": "string",
  "positive_domains": [
    "string"
  ],
  "selected_picture_key": "string",
  "slot_number": "integer",
  "updated_at": "string",
  "updated_by_user_eid": "string"
}

Responses:

200

Success

Returns ICPDetails

POST /audience/v1/ideal_customer_profile/accounts¶

Retrieves ICP Accounts by advertisable EID and optional filters.

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
`advertisable_eid`	True	string	Advertisable EID

Schema for request body: ICPAccountsRequest

{
  "after": "string",
  "domains": {
    "exclude": "boolean",
    "values": [
      "string"
    ]
  },
  "icp_filters": [
    {
      "comparator": "string",
      "eid": "string",
      "grades": "string"
    }
  ],
  "size": "integer"
}

Responses:

200

Success

Returns ICPAccountsResponse

GET /audience/v1/ideal_customer_profile/all_scores¶

Retrieves scores by TAL EID, advertisable EID and optional ICP EID.

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
`tal_eid`	True	string	Target Account List EID
`advertisable_eid`	True	string	Advertisable EID
`icp_eid`	False	string	Optional ICP EID

Responses:

200

Success

Returns ICPScoreList

400

tal_eid is required

GET /audience/v1/ideal_customer_profile/(icp_eid)¶

Retrieves an ICP by ICP EID and advertisable EID.

Parameters:

Path Parameters¶
Name	Required	Type	Description
`icp_eid`	True	string	ICP EID

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
`advertisable_eid`	True	string	Advertisable EID

Responses:

200

Success

Returns ICPDetails

POST /audience/v1/ideal_customer_profile/(icp_eid)¶

Updates an ICP by ICP EID and advertisable EID.

Parameters:

Path Parameters¶
Name	Required	Type	Description
`icp_eid`	True	string	ICP EID

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
`advertisable_eid`	True	string	Advertisable EID

Schema for request body: ICPDetails

{
  "advertisable_eid": "string",
  "attributes": [
    {
      "country": [
        "string"
      ],
      "industry": [
        "string"
      ],
      "revenue": [
        "string"
      ],
      "size": [
        "string"
      ]
    }
  ],
  "created_at": "string",
  "created_by_user_eid": "string",
  "deleted_at": "string",
  "deleted_by_user_eid": "string",
  "domain_filter_settings": {
    "filterBlocks": [
      {
        "dataTypeFilters": [
          {
            "attributeFilters": [
              {
                "attributeDisplayName": "string",
                "attributeName": "string",
                "comparator": "string",
                "from": "string",
                "to": "string",
                "type": "string",
                "uniqueKey": "string",
                "values": [
                  {
                    "displayValue": "string",
                    "value": "string"
                  }
                ]
              }
            ],
            "key": "string",
            "object": "string",
            "source": "string",
            "type": "string"
          }
        ],
        "key": "string"
      }
    ]
  },
  "eid": "string",
  "last_completed_model_uuid": "string",
  "model_status": "string",
  "model_updated_at": "string",
  "model_uuid": "string",
  "name": "string",
  "positive_domains": [
    "string"
  ],
  "selected_picture_key": "string",
  "slot_number": "integer",
  "updated_at": "string",
  "updated_by_user_eid": "string"
}

Responses:

200

Success

Returns ICPDetails

400

Schema failure

DELETE /audience/v1/ideal_customer_profile/(icp_eid)¶

Deletes ICP details by ICP EID and advertisable EID.

Parameters:

Path Parameters¶
Name	Required	Type	Description
`icp_eid`	True	string	ICP EID

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
`advertisable_eid`	True	string	Advertisable EID

Responses:

204: No Content

GET /audience/v1/segments¶

Retrieve list of segments

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
`advertiser_id`	True	string	EID of the advertiser to retrieve segment list for
`type`	False	string	Filter by specified segment type One of: `crm`, `custom`, `impression`, `user_events`, `user_attributes`.
`omit_fields`	False	string	Omit specific fields from the result set

Responses:

200

A segment

Returns SegmentResponse

POST /audience/v1/segments¶

Create a new segment

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

Schema for request body: SegmentCreate

{
  "advertiser_id": "string",
  "conversion_value": "number",
  "data": [
    {
      "email": "string",
      "id": "string"
    }
  ],
  "duration": "integer",
  "general_exclusion_type": "string",
  "is_conversion": "boolean",
  "name": "string",
  "sfdc_company_list_id": "string",
  "type": "string"
}

Responses:

200

A segment

Returns SegmentResponse

POST /audience/v1/segments/bulk¶

Bulk create/update segments. Differs from POST audience/v1/segments as that endpoint can only create/update one segment at a time.

POST /audience/v1/segments/bulk and POST /audience/v1/segments_bulk/put are aliases (i.e. the same endpoint). Use POST /audience/v1/segments_bulk/put, as POST /audience/v1/segments/bulk will be deprecated in the future.

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

Schema for request body: SegmentCreate

{
  "advertiser_id": "string",
  "conversion_value": "number",
  "data": [
    {
      "email": "string",
      "id": "string"
    }
  ],
  "duration": "integer",
  "general_exclusion_type": "string",
  "is_conversion": "boolean",
  "name": "string",
  "sfdc_company_list_id": "string",
  "type": "string"
}

Responses:

200: List of results. Follows the request order. (See segment create and update responses)

GET /audience/v1/segments/general_exclusions¶

Retrieve a list of segments with general exclusions

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
`advertisable_eid`	True	string	The advertisable eid that owns the segments
`general_exclusion_types`	False	string	A comma-separated list of general exclusions types One of: `customers`, `coworkers`, `competitors`.

Responses:

200

The query was successful

Returns SegmentGeneralExclusionResponse

GET /audience/v1/segments/tal_references¶

Returns a list of User Attribute Segments (UAT) that references any TAL or a specific TAL/AG.

Retrieve a list of User Attribute Segments (UAT) that references any TAL or a specific TAL/AG.

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

Schema for request body:

{
  "advertisable_eid": "string",
  "tal_eids": [
    "string"
  ],
  "tal_tier_eids": [
    "string"
  ]
}

Schema

Type:: object

advertisable_eid

The advertisable connected to the TAL reference.

Required:: True
Type:: string

tal_eids

The TAL EIDs connected to the TAL reference

Type:: array of string

tal_tier_eids

The TAL Tier EIDs connected to the TAL reference

Type:: array of string

Responses:

200

The query was successful

Returns SegmentTalReferencesResponse

PUT /audience/v1/segments/tal_references¶

Update or delete TAG/TAL references.

Update/Delete TAL/TAG references

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

Schema for request body:

{
  "advertisable_eid": "string",
  "deleted_tier_eids": {},
  "domains_by_tier_eid": {},
  "tal_eid": "string"
}

Schema

Type:: object

advertisable_eid

The advertisable connected to the TAL reference.

Required:: True
Type:: string

tal_eid

The TAL EID connected to the TAL reference

Required:: True
Type:: string

domains_by_tier_eid

A mapping of domains by tier eid

Required:: True
Type:: object

deleted_tier_eids

The TAL Tier EIDs to be deleted

Required:: True
Type:: object

Responses:

204

The update/delete was successful

Schema as JSON:

{
  "deleted_segments": [
    {
      "attributes": [
        {
          "comparator": "string",
          "display_name": "string",
          "name": "string",
          "source": "string",
          "values": [
            "string"
          ]
        }
      ],
      "attributes_source": "string",
      "cdp_rule_eid": "string",
      "is_targeting_restricted_audience": "boolean",
      "tal_eid": "string",
      "tal_tier_eid": "string",
      "use_first_party_data": "boolean",
      "use_third_party_data": "boolean"
    }
  ],
  "updated_segments": [
    {
      "name": "string"
    }
  ]
}

Schema

Type:: object

updated_segments

Type:: array of AdvertisableAttributesDetail

deleted_segments

Type:: array of UserAttributesSegmentResponse

GET /audience/v1/segments/(segment_id)¶

Retrieve segment information

Parameters:

Path Parameters¶
Name	Required	Type	Description
`segment_id`	True	string	EID of the segment

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
`include_ge_attributes`	False	boolean	whether to include general exclusions attributes
`include_inactive`	False	boolean	whether to include inactive segments

Responses:

200

A segment

Returns SegmentResponse

POST /audience/v1/segments/(segment_id)¶

Update segment information and/or replace user list.

Users can be appended to a segment by including a list of the appropriate user record objects in the payload

Parameters:

Path Parameters¶
Name	Required	Type	Description
`segment_id`	True	string	EID of the segment

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

Schema for request body: SegmentUpdate

{
  "conversion_value": "number",
  "data": [
    {
      "email": "string",
      "id": "string"
    }
  ],
  "duration": "integer",
  "general_exclusion_type": "string",
  "name": "string",
  "sfdc_company_list_id": "string"
}

Responses:

200

A segment

Returns SegmentResponse

DELETE /audience/v1/segments/(segment_id)¶

Delete an existing segment

Parameters:

Path Parameters¶
Name	Required	Type	Description
`segment_id`	True	string	EID of the segment

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

A segment

Returns SegmentResponse

POST /audience/v1/segments_bulk/put¶

Bulk create/update segments. Differs from POST audience/v1/segments as that endpoint can only create/update one segment at a time.

POST /audience/v1/segments/bulk and POST /audience/v1/segments_bulk/put are aliases (i.e. the same endpoint). Use POST /audience/v1/segments_bulk/put, as POST /audience/v1/segments/bulk will be deprecated in the future.

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

Schema for request body: SegmentCreate

{
  "advertiser_id": "string",
  "conversion_value": "number",
  "data": [
    {
      "email": "string",
      "id": "string"
    }
  ],
  "duration": "integer",
  "general_exclusion_type": "string",
  "is_conversion": "boolean",
  "name": "string",
  "sfdc_company_list_id": "string",
  "type": "string"
}

Responses:

200: List of results. Follows the request order. (See segment create and update responses)

GET /audience/v1/sharing/get_source_segment¶

Fetch details of the audience that wants to be shared with a sharing invitation

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
`invitation_eid`	True	string	EID of the invitation
`advertisable_eid`	True	boolean	EID of the advertisable receiving the invitation

Responses:

200

A segment

Returns SegmentResponse

GET /audience/v1/sharing/invitation¶

Fetch all Invitations sent by an Advertisable or an specific Invitation.

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
`invitation_eid`	False	string	EID of the invitation
`source_advertisable_eid`	False	string	EID of the Advertisable sharing the segment
`target_advertisable_eid`	False	string	EID of the Advertisable sharing the segment
`include_accepted`	False	boolean	Include accepted Invitations in the response. Defaults to false.

Responses:

200

A list of Invitations

Returns SharingSegmentInvitationListResponse

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
`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
`segment_eid`	True	string	EID of the Segment to share
`advertisable_eid`	True	string	EID of the Advertisable to share the Segment with

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
`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
`invitation_eid`	True	string	EID of the invitation

Responses:

200

An invitation

Returns SharingSegmentInvitationResponse

POST /audience/v1/sharing/segment¶

Accept a Segment Sharing Invitation and create a Mirror Segment.

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
`invitation_eid`	True	string	EID of the invitation
`name`	False	string	Name of the Mirror Segment to be created. If omitted, the name of the source segment is used.

Responses:

200

A segment

Returns SegmentResponse

DELETE /audience/v1/sharing/segment¶

Delete a Mirror Segment.

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
`segment_eid`	True	string	EID of the Mirror Segment to delete.

Responses:

200

A segment

Returns SegmentResponse

GET /audience/v1/target_accounts¶

Retrieve a all Target Accounts Lists

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
`advertisable_eid`	True	string	The advertisable EID filter
`scoring_model_id`	False	string	The scoring model ID filter
`include_deleted`	False	boolean	whether to include deleted TALs and TAGs

Responses:

200

Target Accounts List results

Returns TargetAccountsListAllResponse

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts¶

Create a new Target Accounts List

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsListCreate

{
  "advertisable_eid": "string",
  "domains": [
    "string"
  ],
  "name": "string",
  "sfdc_company_list_name": "string",
  "sfdc_company_list_object_id": "string",
  "sfdc_sync_state": "string",
  "source": "string"
}

Responses:

200

The created Target Accounts List

Returns TargetAccountsList

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts/domain_references¶

Retrieve the references for a set of domains

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
`advertisable_eid`	True	string	The advertisable EID who owns the entities to query

Schema for request body: DomainReferencesRequest

{
  "domains": [
    "string"
  ],
  "entities": [
    "string"
  ],
  "verbose": "boolean"
}

Responses:

200

The query was successful

Returns DomainReferencesResponse

400

Bad request

404

Resource not found or Unauthorized

GET /audience/v1/target_accounts/domains¶

Retrieve the list of domains that are present in any Target Account List

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
`advertisable_eid`	True	string	The advertisable EID that owns the Target Account Lists

Responses:

200

The query was successful

Schema as JSON:

{
  "domains": [
    "string"
  ]
}

Schema

Type:: object

domains

Type:: array of string

400

Bad request

404

Resource not found or Unauthorized

GET /audience/v1/target_accounts/general_exclusions¶

Retrieve a list of Target Accounts List with general exclusions

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
`advertisable_eid`	True	string	The advertisable eid that owns the Target Accounts Lists
`include_deleted`	False	boolean	Whether to include deleted Target Accounts Lists in the response
`include_domain_filter_settings`	False	boolean	Whether to include domain filter settings in the response

Responses:

200

The query was successful

Returns TargetAccountsList

GET /audience/v1/target_accounts/names¶

Retrieve all Target Accounts List Names and Eids

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
`advertisable_eid`	True	string	The advertisable EID filter

Responses:

200

Target Accounts List Name and Eid results

Returns TargetAccountsListAllNameEidResponse

400

Bad request

404

Resource not found or Unauthorized

GET /audience/v1/target_accounts/(tal_eid)¶

Get a Target Accounts List

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Responses:

200

The requested Target Accounts List

Returns TargetAccountsList

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts/(tal_eid)¶

Update a Target Accounts List

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsListUpdate

{
  "eid": "string",
  "name": "string",
  "scoring_auc": "number",
  "scoring_grades": {
    "A": {
      "threshold": "integer"
    },
    "B": {
      "threshold": "integer"
    },
    "C": {
      "threshold": "integer"
    },
    "D": {
      "threshold": "integer"
    },
    "F": {
      "threshold": "integer"
    }
  },
  "scoring_holdout1_status": "string",
  "scoring_holdout2_status": "string",
  "scoring_holdout3_status": "string",
  "scoring_holdout4_status": "string",
  "scoring_holdout5_status": "string",
  "scoring_items_pending": "boolean",
  "scoring_production_status": "string",
  "scoring_status": "string",
  "sfdc_sync_state": "string",
  "sfdc_synced_at": "string"
}

Responses:

200

The updated Target Accounts List

Returns TargetAccountsList

400

Bad request

404

Resource not found or Unauthorized

DELETE /audience/v1/target_accounts/(tal_eid)¶

Delete a Target Accounts List

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID

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
`advertisable_eid`	True	string	The advertisable EID filter
`force`	False	boolean	Force the deletion even though there are audiences/campaigns associated with this TAL

Responses:

204: The Target Accounts List have been deleted successfully
400: Bad request
404: Resource not found or Unauthorized

GET /audience/v1/target_accounts/(tal_eid)/tiers¶

Retrieve all Target Accounts Tiers

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Responses:

200

Target Accounts List results

Returns TargetAccountsTiersAllResponse

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts/(tal_eid)/tiers¶

Create a new Target Accounts Tier

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsTierCreate

{
  "domains": [
    "string"
  ],
  "filters": {
    "grades": [
      "string"
    ],
    "is_scored": "boolean",
    "score": {
      "from": "integer",
      "to": "integer"
    }
  },
  "force": "boolean",
  "inverted_for_tier_eid": "string",
  "name": "string"
}

Responses:

200

The created Target Accounts Tier

Schema as JSON:

{
  "skipped_domains": "integer",
  "tier": {
    "created_at": "string",
    "eid": "string",
    "items_count": "integer",
    "name": "string",
    "tal_eid": "string"
  }
}

Schema

Type:: object

tier

Type:: TargetAccountsTier

skipped_domains

The number of skipped accounts that are tiered already

Type:: integer

400

Bad request

404

Resource not found or Unauthorized

GET /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)¶

Retrieve a single Target Accounts Tier

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Responses:

200

Target Accounts List results

Returns TargetAccountsTier

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)¶

Update a Target Accounts Tier

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsTierUpdate

{
  "eid": "string",
  "name": "string"
}

Responses:

200

The updated Target Accounts Tier

Returns TargetAccountsTier

400

Bad request

404

Resource not found or Unauthorized

DELETE /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)¶

Delete a single Target Accounts Tier

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Responses:

204: The Target Accounts Tier have been deleted successfully
400: Bad request
404: Resource not found or Unauthorized

GET /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items¶

Retrieve all Target Accounts Items

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter
`offset`	False	integer	The offset
`limit`	False	integer	The max items to return
`order`	False	string	The name of an attribute to order by
`desc`	False	boolean	Flag to make the order descending/ascending
`grades`	False	string	A comma-separated list of grades: A, B, C, D, F

Responses:

200

Target Accounts List results

Returns TargetAccountsItemsAllResponse

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items¶

Upsert Target Accounts List items

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsItemsListUpdate

{
  "items": [
    {
      "domain": "string",
      "score": "number",
      "sfdc_synced_at": "string",
      "source": "string"
    }
  ]
}

Responses:

200

The domains inserted/updated

Schema as JSON:

{
  "existing_domains": [
    "string"
  ],
  "new_domains": [
    "string"
  ]
}

Schema

Type:: object

existing_domains

The domains that have been inserted/updated

Type:: array of string

new_domains

The new domains inserted

Type:: array of string

400

Bad request

404

Resource not found or Unauthorized

PUT /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items¶

Updates Target Accounts List items

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsItemsListUpdate

{
  "items": [
    {
      "domain": "string",
      "score": "number",
      "sfdc_synced_at": "string",
      "source": "string"
    }
  ]
}

Responses:

200

The domains inserted/updated

Schema as JSON:

{
  "existing_domains": [
    "string"
  ],
  "new_domains": [
    "string"
  ]
}

Schema

Type:: object

existing_domains

The domains that have been inserted/updated

Type:: array of string

new_domains

The new domains inserted

Type:: array of string

400

Bad request

404

Resource not found or Unauthorized

DELETE /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items¶

Delete a list of Target Accounts List Items

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsItemsListDelete

{
  "domains": [
    "string"
  ],
  "filters": {
    "grades": [
      "string"
    ],
    "is_scored": "boolean",
    "score": {
      "from": "integer",
      "to": "integer"
    }
  },
  "force": "boolean",
  "inverted": "boolean"
}

Responses:

204: The Target Accounts List items have been deleted successfully
400: Bad request
404: Resource not found or Unauthorized

POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items/delete¶

Delete a list of Target Accounts List Items

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter

Schema for request body: TargetAccountsItemsListDelete

{
  "domains": [
    "string"
  ],
  "filters": {
    "grades": [
      "string"
    ],
    "is_scored": "boolean",
    "score": {
      "from": "integer",
      "to": "integer"
    }
  },
  "force": "boolean",
  "inverted": "boolean"
}

Responses:

204: The Target Accounts List items have been deleted successfully
400: Bad request
404: Resource not found or Unauthorized

POST /audience/v1/target_accounts/(tal_eid)/tiers/(ta_tier_eid)/items/filter¶

Retrieve all Target Accounts Items filtered

Parameters:

Path Parameters¶
Name	Required	Type	Description
`tal_eid`	True	string	The Target Accounts List EID
`ta_tier_eid`	True	string	The Target Accounts Tier EID

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
`advertisable_eid`	True	string	The advertisable EID filter
`grades`	False	string	A comma-separated list of grades: A, B, C, D, F

Schema for request body: TargetAccountsItemsSearch

{
  "domains": [
    "string"
  ],
  "filters": {
    "grades": [
      "string"
    ],
    "is_scored": "boolean",
    "score": {
      "from": "integer",
      "to": "integer"
    }
  },
  "inverted": "boolean"
}

Responses:

200

Target Accounts List results

Returns TargetAccountsItemsAllResponse

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/user_attribute_counts¶

Retrieve user attribute counts for a pair of attribute name and value

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

Schema for request body: UserAttributeCountsRequest

{
  "attributes": {}
}

Responses:

200

A map of attribute names to values to count of users with that pair of name/value

Returns UserAttributeCountsResponse

GET /audience/v1/user_attribute_names/(advertisable_eid)¶

Retrieve user attributes associated with an advertisable

Parameters:

Path Parameters¶
Name	Required	Type	Description
`advertisable_eid`	True	string	EID of the advertisable

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
`first_party`	False	boolean	Include first party attributes
`third_party`	False	boolean	Include third party denormalized attributes
`source`	False	string	Source to retrieve. bombora (default) or rollworks-normalized
`categorized`	False	boolean	Available only for the normalized source. Whether to output categorized attributes

Responses:

200

List of user attributes associated with an advertisable

Returns AdvertisableAttributes

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

TargetAccountsListAllNameEidResponse¶

All Target Accounts Lists Eids response

Type:: object

results

An array of Target Accounts Lists

Type:: array of TargetAccountsListNameEid

TargetAccountsListNameEid¶

The Target Accounts Lists (TAL)

Type:: object

eid

The Target Accounts List EID

Type:: string

name

The Target Accounts List name

Type:: string

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

(Deprecated) 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

{

    "domain": string

    "score": number

}

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 string

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 string

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 string

entities

Entities to query

Type:: array of enum [‘campaigns’, ‘playbooks’, ‘target_accounts’]

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 enum [‘A’, ‘B’, ‘C’, ‘D’, ‘F’]

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 string

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 string

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 string

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

is_targeting_restricted_audience

Type:: boolean

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

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 string

industry

Type:: array of string

revenue

Type:: array of string

size

Type:: array of string

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 string

last_completed_model_uuid

Type:: string

selected_picture_key

Type:: string

name

Type:: string

created_at

Type:: string

domain_filter_settings

Type:

object

{

    "filterBlocks": :openapi:schema:`ICPFilterBlocks`

}

slot_number

Type:: integer

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

{

    "exclude": boolean

    "values": array of string

}

after

Type:: string

size

Type:: integer

ICPAccountsResponse¶

Type:: object

page_info

Type:

object

{

    "start_cursor": string

    "end_cursor": string

}

results

Type:: array of object

total_count

Type:: integer
Format:: int32

ICPScoreList¶

Type:: object

results

Type:: array of object