▼ campaign object
campaign_id required integer
An internal identifier for a campaign id that is also assigned to the pixel
name required string
The name of a campaign that's also assigned to the pixel
▼ category_count object
count required string
The total number of items returned by the endpoint.
fieldName required string
Default value is "TOTAL". If categorized, the category name.
fieldValue required string
Default value is "TOTAL". If categorized, the category value.
▼ filter object
fieldName required string
field to be filtered
operation required string
operation to be applied on the field. Allowed values are EQUALS, LIKE (%), BETWEEN, NEQ (!=), GEQ (>=), LEQ (<=), GT (>), LT (<), IS, IS NOT (the last two are for null comparison)
values required string[]
list of values to be filtered on. any of the values that match are returned.
▼ inherited_object object
from string
the level of inheritance
is_override boolean
whether the parent
parent_value integer
the id of the parent (for example, the company id)
▼ inherited_pixel object
click_attribution_rate
inherited_object
The Click attribution rate
click_referral_days
inherited_object
The Click referral days
view_attribution_rate
inherited_object
The view attribution rate
view_referral_days
inherited_object
The View referral days
▼ pixel object
advertiser_id integer
Unique identifier of the organization (definer) to which the pixel belongs.
app_instance_id integer
assigned_campaigns
campaign
[]
List of campaigns the pixel is assigned to
click_attribution_rate integer
click_referral_days integer
company_id required integer
Unique identifier of the organization (definer) to which the pixel belongs.
conversion_sub_type integer
conversion_sub_type_name string
conversion_type integer
conversion_type_name string
create_date string
ISO-8601 string representation of the date the pixel was created.
description string
fires integer
Number of pixel fires
id integer
Unique identifier of the pixel.
inheritance
inherited_pixel
an object containing inheritance data about the pixel
is_assigned_to_multiple_campaigns boolean
Indicates whether the pixel is already assigned to another campaign
is_deleted boolean
is_shared_pixel boolean
Indicates whether the pixel is a shared pixel belonging to another company
last_modified_time string
last_modifying_user string
name required string
Descriptive name for the pixel.
pixel_id required integer
Unique identifier of the pixel.
pixel_type integer
Applicable only to third party pixels. This is the pixel type code
pixel_type_name string
Applicable only to third party pixels. This is the pixel type name
shared_company_name string
If the pixel is a shared pixel, this is the company the pixel was shared from
status required string
Indicates the pixel's status.
tag_map_code required string
Unique string identifying the pixel's tag map.
tracking_domain string
Either 'rfi' or 'ru4'
view_attribution_rate integer
view_referral_days integer
▼ search_request object
fields string[]
list of fields to be returned, if we only want to return specific fields. If not specified, all fields are returned.
filters
filter[]
list of filters to be applied, if any. If not specified, all items are returned.
noPaging boolean
an option to ignore paging and return all entries.
pageSize integer
number of items returned in this page. If not specified, the default is 25.
search string
a search pattern to be applied, if any. If any of the fields in the response contain this pattern, it is returned.
▼ search_response object
category_counts
required
category_count[]
returns count of items returned, optionally grouped by category, if requested.
hasNextPage required boolean
indicates whether there are more pages or no.
items
required
pixel[]
list of pixels that match the search criteria, if any.
pageIdx required integer
indicates what page number this current page is.
page_size required integer
number of items returned in this page.
totalPages required integer
total number of pages returned by the endpoint.