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 by apihelp@adroll.com

Manage your segments with the AdRoll Audience API

Operations by Tag

Operations

GET /audience/v1/advertisers

Retrieve list of accessible advertisers

Retrieve list of accessible advertisers

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. 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

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

advertiser_id

True

string

Advertisable eid to retrieve list of valid segments

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

List of valid/invalid segments for crosschannel targeting

Returns CrossChannelLalValidSegments

POST /audience/v1/domain_attributes

Fetch known attributes about a list of domains

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body:

[
  "string"
]
Schema
Type

array

Responses:

200

Attributes associated with the submitted domains

Returns DomainAttributesResponse

GET /audience/v1/segments

Retrieve list of segments

Retrieve list of segments

Parameters:

Query Parameters

Name

Required

Type

Description

advertiser_id

True

string

EID of the advertiser to retrieve segment list for

type

False

string

Filter by specified segment type One of: user_attributes, crm, custom, impression, user_events.

omit_fields

False

string

Omit specific fields from the result set

apikey

False

string

Required if using HTTP Basic Authentication. 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

Create a new segment

Create a new segment

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. 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": 0.0,
  "data": [
    {
      "email": "string",
      "id": "string"
    }
  ],
  "is_conversion": true,
  "name": "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 HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body:

[
  {
    "advertiser_id": "string",
    "conversion_value": 0.0,
    "data": [
      {
        "email": "string",
        "id": "string"
      }
    ],
    "is_conversion": true,
    "name": "string",
    "type": "string"
  }
]
Schema
Type

array

Responses:

200

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

GET /audience/v1/segments/(segment_id)

Retrieve segment information

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 HTTP Basic Authentication. 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/(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 HTTP Basic Authentication. 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": 0.0,
  "data": [
    {
      "email": "string",
      "id": "string"
    }
  ],
  "duration": 0,
  "name": "string"
}

Responses:

200

A segment

Returns SegmentResponse

DELETE /audience/v1/segments/(segment_id)

Delete an existing segment

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 HTTP Basic Authentication. 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 HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body:

[
  {
    "advertiser_id": "string",
    "conversion_value": 0.0,
    "data": [
      {
        "email": "string",
        "id": "string"
      }
    ],
    "is_conversion": true,
    "name": "string",
    "type": "string"
  }
]
Schema
Type

array

Responses:

200

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

GET /audience/v1/target_accounts

Retrieve a all Target Accounts Lists

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

The advertisable EID filter

scoring_model_id

False

string

The scoring model ID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsListCreate

"Unknown type"

Responses:

200

The created Target Accounts List

Returns TargetAccountsList

400

Bad request

404

Resource not found or Unauthorized

POST /audience/v1/target_accounts/create_from_discover

Create a new Target Accounts List from Discover Accounts

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsListCreateFromDiscoverAccounts

"Unknown type"

Responses:

200

The created Target Accounts List

Returns TargetAccountsList

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsListUpdate

{
  "eid": "string",
  "name": "string",
  "scoring_auc": 0.0,
  "scoring_grades": {
    "A": {
      "threshold": 0
    },
    "B": {
      "threshold": 0
    },
    "C": {
      "threshold": 0
    },
    "D": {
      "threshold": 0
    },
    "F": {
      "threshold": 0
    }
  },
  "scoring_holdout1_status": "string",
  "scoring_holdout2_status": "string",
  "scoring_holdout3_status": "string",
  "scoring_holdout4_status": "string",
  "scoring_holdout5_status": "string",
  "scoring_items_pending": true,
  "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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsTierCreate

"Unknown type"

Responses:

200

The created Target Accounts Tier

Schema as JSON:

{
  "skipped_domains": 0,
  "tier": {
    "eid": "string",
    "items_count": 0,
    "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

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

Create a new Target Accounts Tier from Discover Accounts

Parameters:

Path Parameters

Name

Required

Type

Description

tal_eid

True

string

The Target Accounts List EID

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsTierCreateFromDiscoverAccounts

"Unknown type"

Responses:

200

The created Target Accounts Tier

Schema as JSON:

{
  "skipped_domains": 0,
  "tier": {
    "eid": "string",
    "items_count": 0,
    "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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

advertisable_eid

True

string

The advertisable EID filter

dat

False

boolean

Flag to return the report items instead of raw items

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

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

Update a 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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsItemsListUpdate

{
  "items": [
    {
      "domain": "string",
      "score": 0.0,
      "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 updated

Type

array of items

new_domains

The new domains inserted

Type

array of items

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsItemsListDelete

{
  "domains": [
    "string"
  ],
  "filters": {
    "company_attributes": {
      "alexa_rank": {
        "from": 0,
        "to": 0
      },
      "country": {
        "values": [
          "string"
        ]
      },
      "domain": {
        "values": [
          "string"
        ]
      },
      "industry": {
        "values": [
          "string"
        ]
      },
      "revenue": {
        "values": [
          "string"
        ]
      },
      "size": {
        "values": [
          "string"
        ]
      },
      "technologies": {
        "values": [
          "string"
        ]
      }
    },
    "cookie_count": {
      "from": 0,
      "to": 0
    },
    "grades": [
      "string"
    ],
    "is_matched": true,
    "is_scored": true,
    "score": {
      "from": 0,
      "to": 0
    },
    "search": {
      "attributes": [
        "string"
      ],
      "value": "string"
    }
  },
  "force": true,
  "inverted": true
}

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/add_from_discover

Add new Target Accounts List items from Discover Accounts

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsItemsAddFromDiscoverAccounts

"Unknown type"

Responses:

200

The domains inserted and the ones that already exist

Schema as JSON:

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

object

existing_domains

The domains that were already in the Target Accounts List

Type

array of items

new_domains

The new domains inserted

Type

array of items

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsItemsSearch

{
  "domains": [
    "string"
  ],
  "filters": {
    "company_attributes": {
      "alexa_rank": {
        "from": 0,
        "to": 0
      },
      "country": {
        "values": [
          "string"
        ]
      },
      "domain": {
        "values": [
          "string"
        ]
      },
      "industry": {
        "values": [
          "string"
        ]
      },
      "revenue": {
        "values": [
          "string"
        ]
      },
      "size": {
        "values": [
          "string"
        ]
      },
      "technologies": {
        "values": [
          "string"
        ]
      }
    },
    "cookie_count": {
      "from": 0,
      "to": 0
    },
    "grades": [
      "string"
    ],
    "is_matched": true,
    "is_scored": true,
    "score": {
      "from": 0,
      "to": 0
    },
    "search": {
      "attributes": [
        "string"
      ],
      "value": "string"
    }
  },
  "inverted": true
}

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/move

Move Target Accounts List items from one tier to another

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

advertisable_eid

True

string

The advertisable EID filter

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: TargetAccountsItemsListMove

{
  "destination_tier_eid": "string",
  "domains": [
    "string"
  ],
  "filters": {
    "company_attributes": {
      "alexa_rank": {
        "from": 0,
        "to": 0
      },
      "country": {
        "values": [
          "string"
        ]
      },
      "domain": {
        "values": [
          "string"
        ]
      },
      "industry": {
        "values": [
          "string"
        ]
      },
      "revenue": {
        "values": [
          "string"
        ]
      },
      "size": {
        "values": [
          "string"
        ]
      },
      "technologies": {
        "values": [
          "string"
        ]
      }
    },
    "cookie_count": {
      "from": 0,
      "to": 0
    },
    "grades": [
      "string"
    ],
    "is_matched": true,
    "is_scored": true,
    "score": {
      "from": 0,
      "to": 0
    },
    "search": {
      "attributes": [
        "string"
      ],
      "value": "string"
    }
  },
  "force": true,
  "inverted": true
}

Responses:

200

The items have been moved

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 HTTP Basic Authentication. 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

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

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

List of user attributes associated with an advertisable

Returns AdvertisableAttributes

GET /audience/v1/warehouses

Fetch warehouses by advertisable EID

Parameters:

Query Parameters

Name

Required

Type

Description

advertiser_id

True

string

EID of advertisable attached to warehouse

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

Database warehouse

Schema as JSON:

[
  {
    "advertiser_id": "string",
    "comments": "string",
    "created_date": 0,
    "db_host": "string",
    "db_name": "string",
    "db_password": "string",
    "db_port": 0,
    "db_schema": "string",
    "db_type": "string",
    "db_username": "string",
    "email_opt_in": true,
    "id": 0,
    "is_active": true,
    "warehouse_eid": "string"
  }
]
Schema
Type

array

POST /audience/v1/warehouses

Create new warehouse

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body:

{
  "advertiser_id": "string",
  "db_host": "string",
  "db_name": "string",
  "db_password": "string",
  "db_port": 0,
  "db_type": "string",
  "db_username": "string"
}
Schema
db_type

Type of database

Type

string

Enum

redshift, postgresql, mysql

db_host

Host of database

Type

string

db_name

Database name

Type

string

db_password

Password associated with db_username

Type

string

db_port

Database port

Type

integer

db_username

Username to connect to database with

Type

string

advertiser_id

Advertisable EID of attached warehouse.

Type

string

Responses:

200

Database warehouse

Returns WarehouseResponse

DELETE /audience/v1/warehouses/(warehouse_eid)

Delete a warehouse specified by the warehouse EID

Parameters:

Path Parameters

Name

Required

Type

Description

warehouse_eid

True

string

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

204

Success response

Schema as JSON:

{}
Schema
Type

object

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

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

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

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

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

AdvertisableAttributes
Type

object

attributes

List or detailed list of user attributes from an advertisable

Type

array of AdvertisableAttributesDetail

AdvertisableAttributesDetail
Type

object

name
Type

string

DomainAttributesResponse
Type

object

UserAttributeCountsRequestAttributes
Type

object

UserAttributeCountsRequest
Type

object

attributes
Type

UserAttributeCountsRequestAttributes

UserAttributeCountsRequestResult
Type

object

UserAttributeCountsResponse
Type

object

results
Type

UserAttributeCountsRequestResult

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

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_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

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
TargetAccountsTierCreateFromDiscoverAccounts

Create a Target Accounts Tier from Discover Accounts

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

TextAttributeFilter

Filter for Company Attributes text field

Type

object

values
Type

array of items

CompanyAttributesFilter

Filter for Company Attributes

Type

object

alexa_rank
Type

NumericAttributeFilter

country
Type

TextAttributeFilter

domain
Type

TextAttributeFilter

industry
Type

TextAttributeFilter

revenue
Type

TextAttributeFilter

size
Type

TextAttributeFilter

technologies
Type

TextAttributeFilter

DiscoverAccountsFilter

Filter for Discover Accounts

Type

object

company_attributes
Type

CompanyAttributesFilter

exclude_tal
Type

boolean

FromDiscoverAccountsBase

Base definition for From Discover Accounts

Type

object

domains
Required

True

Type

array of items

inverted

Tells if domains is the oposite selection

Type

boolean

filters
Type

DiscoverAccountsFilter

TargetAccountsListCreateFromDiscoverAccounts

Create a Target Accounts List from Discover Accounts

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

company_attributes

Filter only items that matches the given company attributes

Type

CompanyAttributesFilter

cookie_count

Filter only items that are between the given counts

Type

NumericAttributeFilter

is_scored

Filter only items that are scored

Type

boolean

is_matched

Filter only items that matches against the DAT table

Type

boolean

score

Filter only items that are between the given scores

Type

NumericAttributeFilter

grades

Filter only items that are in the given grades

Type

array of items

search

Custom search

Type

object

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 segments/campaigns associated with this item

Type

boolean

TargetAccountsItemsAddFromDiscoverAccounts

Add new Target Accounts List items from Discover Accounts

TargetAccountsItemsListMove

Move a list of domains from one tier to another

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

destination_tier_eid

The destination tier to move the domains to. This can be the calculated untiered tier

Type

string

force

Force the deletion even though there are segments/campaigns 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