Skip to end of metadata
Go to start of metadata

Lookup Service

This read-only service allows you to retrieve the ID, name, code, state, and, in some cases, description of the following types of objects in your account. It also returns hierarchical information about these objects, for example, publisher ID for a placement or advertiser ID for a line item. In cases where you have limited information about objects, this service therefore gives you an easy way to map to other relevant data. Bulk Reporting Feeds, for example, returns data grouped by object IDs. You can use the Lookup Service to match these IDs with names, codes, etc.

  • Advertisers
  • Insertion Orders
  • Line Items
  • Campaigns
  • Creatives
  • Segment Pixels
  • Conversion Pixels
  • Publishers
  • Payment Rules
  • Sites
  • Placements
  • Labels

The Lookup Service is different from the Search Service because it returns all objects of a certain type in your account. The Search Service allows you to search for objects with a specific name, code, or ID.

The Lookup Service can return a maximum of 50,000 objects.

Please note that the Lookup Service is based on data that is cached and updated once every 8 minutes.

On This Page

REST API

View information about all objects in your system:

View information about all objects of a specific type:

You can get information about the following object types: advertiser, insertion_order, line_item, campaign, creative, segment_pixel, conversion_pixel, publisher, payment_rule, placement, site, and label.

View information about all objects belonging to a specific advertiser:

JSON Fields

Fields returned for all object types:

Field

Type

Description

id

int

The internal ID associated with the object.

name

string

The name of the object.

code

string

The custom code for the object (not applicable to all object types).

state

enum

The state of the object. Possible values: "active" or "inactive".

last_modified

timestamp

The date and time when the object was last modified.

Object- Specific JSON fields

Additional fields returned for specific object types.

Advertiser

Field

Type

Description

member_id

int

The ID of the member to which the advertiser belongs.

Insertion Order

Field

Type

Description

advertiser_id

int

The ID of the advertiser to which the insertion order belongs.

Line Item

Field

Type

Description

advertiser_id

int

The ID of the advertiser to which the line item belongs.

Campaign

FieldTypeDescription
line_item_idintThe ID of the line item to which the campaign belongs.

Creative

Field

Type

Description

description

string

The description of the creative.

advertiser_id

int

The ID of the advertiser to which the creative belongs.

publisher_id

int

The ID of the publisher to which the creative is associated.

brand_id

int

The ID of the brand associated to the creative.

landing_page_url

string

The URL of the landing page associated with this creative.

Segment Pixel

Field

Type

Description

member_id

int

The ID of the member to which the segment pixel belongs.

advertiser_id

int

The ID of the advertiser to which the segment pixel is associated.

Conversion Pixel

Field

Type

Description

advertiser_id

int

The ID of the advertiser to which the conversion pixel belongs.

Publisher

Field

Type

Description

member_id

int

The ID of the member to which the publisher belongs.

Payment Rule

Field

Type

Description

publisher_id

int

The ID of the publisher to which the payment rule belongs.

description

string

The description of the payment rule.

Placement

Field

Type

Description

publisher_id

int

The ID of the publisher to which the placement belongs.

Site

Field

Type

Description

publisher_id

int

The ID of the publisher to which the site belongs.

Label

Field

Type

Description

member_id

int

The ID of the member to which the label belongs.

label_idintThe ID of the label.
object_idintThe ID of the object to which the label can be applied.

object_type

enum

The type of object to which the label can be applied. Possible values: "advertiser", "insertion_order", "line_item", "campaign", or "publisher".

valuestringThe label text.

Examples

Looking up all of your campaigns
Looking up all objects accessible to this service