LiveRail API

APPLICATION PROGRAMMING INTERFACE
USER MANUAL
Version: 1.7
Date: 24 January 2013
LiveRail API Foreword

This mini-guide is intended to be a quick overview of all the available Liverail API
methods. It's not an exhaustive documentation and does not explain all the
internals of LiveRail.
The LiveRail API is available using simple POST over HTTP requests sent to the
LiveRail API server. The API server response is always in XML format. There are
two available API servers that can be used at any given time.
api4.int.liverail.com pre-production server To be used only for API client testing.
It's just a sandbox that allows you to test your client implementation. The database
behind is a daily snapshot of the production database so any errors in the client
implementation will not affect the data in production.
Parameters
Each API call contains required and optional parameters. Here is an overview of the
parameters you can add to this particular API request, where required parameters
are written in orange:
Name
Required Type Overview Example
sample sample
Required
yes
sample example
parameter
type overview
Authentication
string session token token=f5a81cdde43c6334feffcfc13ad53717
token
yes
(received
after /login).
sample
Optional
sample
no
sample example
parameter
type overview
Return
<liverailapi requested="/connection/resolve/name" api_version="X.Y.Z">
<connections>
<connection>
<connection_id>the id of the connection</connection_id>
<name>the name of the connection</name>
</connection>
...
<connections>
<user>...</user>
<auth>...</auth>
<status>success or fail</status>
<error>error if status=fail, null otherwise</error>
...
</liverailapi>
Change History
Date
Description
Reason
LOGGING IN AND OUT
The login process is achieved using the /login API method. It requires two parameters: 1.
username: the full e-mail address (username) of the LiveRail client 2. password: the usernames
password sent as an MD5 hash. The /login method will return an XML containing the
authentication token or session ID. This token must be passed to all API sub sequential calls
through the token parameter and is considered to be an implied parameter for all the methods.
Before disconnecting from the LiveRail API, a polite API client must use the API method /logout.
/login
/logout
Method Name: /login

Method Description
A simple method for logging in an user.
Parameters
Name
Required Type Overview

Example
The
user's
login
string
username yes
username=test123
name.
MD5 hash format of
string the user's clear-text password=???
password yes
password
MD5 hash format
key which identifies
the permission
given to the user for
a certain entity. It
can limit access for
an entity and all its
children. When the
key does not have
string an entity attached, api_key=awre8g6yad766253dgiewf9
api_key no
it will work for all
the entities (the
previous login
system). If the
entered key is not
correct, it will be
ignored. The
default value is
"null".
Return
<liverailapi requested="/login" api_version="X.Y.Z">
<error>
<code>Error code</code>
<message>Human readable error message.</message>
</error>
<user>
<id>User's numeric ID</id>
<name>User's full name</name>
<admin>1 only for special root users</admin>
<email>User's e-mail</email>
<timezone>User's timezone (GMT offset)</timezone>
</user>
<auth>
<token>Authentication session token</token>
</auth>
<buildtime metric="second">Response build time in seconds (float)</buildtime>
<executiontime metric="second">Method execution time in seconds (float)</executiontime>
</liverailapi>
<error>...</error> is returned only if status is fail.
Change History
Date
Description
Reason
Method Name: /logout

Method Description
A simple method for logging out an user.
Parameters
Name Required Type Overview
Authentication
session token
string
token yes
(received after
/login).
Example
token=f5a81cdde43c6334feffcfc13ad53717
Return
<liverailapi requested="/login" api_version="X.Y.Z">
<error>
</error>
<user>
</user>
<auth>
</auth>
</liverailapi>
<error>...</error> is returned only if status is fail.
Change History
Date
Description
Reason
SET / UNSET ENTITY
After the API client is logged in, the client must select an entity. To select an entity, the API client
must use the /set/entity method, using the entity ID as a value for the parameter entity_id.
/set/entity
/unset/entity
Method Name: /set/entity

Method Description
Select and attach the current user to an entity.
Parameters
Name Required Type Overview Example
Authentication
token yes
(received
after /login).
The
integer numerical ID entity_id=788
entity_id yes
of the entity
to be edited.
Return
<liverailapi requested="/set/entity" api_version="X.Y.Z">
<error>
</error>
<user>
</user>
<auth>
<entity>
<entity_id>Selected entity's ID</entity_id>
<user_role>User's role on the selected entity (admin, cust-ro, cust-rw)</user_role>
<entity_name>Name of the entity</entity_name>
<perspective>The perspective of the current user over the selected entity</perspective>
<parent_id>The parent entity ID for the current entity. Can be null.</parent_id>
</entity>
</auth>
</liverailapi>
Change History
Date
Description
Reason
Method Name: /unset/entity

Method Description
Detach the current user from any previously attached entities.
Parameters
Authentication
session token
string
token yes
(received after
/login).
Example
Return
<liverailapi requested="/unset/entity" api_version="X.Y.Z">
<error>
</error>
<user>
</user>
<auth>
</auth>
</liverailapi>
Change History
Date
Description
Reason
ENTITIES
All the methods related to entities are displayed here.

/entity/add
/entity/edit
/entity/list
/entity/delete
/entity/list/bychar
/entity/resolve/name
/entity/exchange/list
/entity/publisher/category/list
/entity/network/type/list
/entity/network/type/parameter/list
/entity/integration/get
Method Name: /entity/list

Method Description
List all the available entities or the information for a given entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
which the
information
will be
integer returned. If entity_id = 1|7|120 or entity_id = 1,7,120
entity_id
no
you have
multiple id(s)
you can make
a single call
by gluing
them together
with | or ,
The numeric
ID of the
parent entity
for which the
children
entities will be
integer returned. If parent_id = 1|7|120 or parent_id = 1,7,120
parent_id
no
you have
multiple id(s)
you can make
a single call
by gluing
them together
with | or ,
Returns only
the entities
that have an
organization
name starting
with this
string ( this
method could
be used to
string organize the like_organization=te
like_organization no
entities by
count_only
no
limit
no
offset
no
starting letters
). If you set
this
parameter to
#, the call will
return only
the entities
that don't start
with a..z.
If you set this
flag to 1, the
API will return
integer only the count count_only=1
of entities
matching the
parameter
set.
Limit the
number of
int
limit=50
results for
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
10 entities per
page and you
need to get
int
the 3rd page offset=5
you should
set offset to
20 and limit to
10 ). Do not
use without
specifying the
limit
parameter as
well.
Return
<liverailapi requested="/entity/list" api_version="X.Y.Z">
<total>The total number of listed entities</total>
<entities>
<entity>
<entity_id>entity's ID</entity_id>
<parent_id>null if the entity is a root entity, parent's entity ID otherwise</parent_id>
<perspective>the perspective of the entity; P for Publisher, N for Network, A for Advertiser, M for Marketplace</perspective>
<creation_time>entity's creation full date (YYYY-MM-DD HH:MM:SS)</creation_time>
<organization>entity's name (organization)</organization>
<address>entity's postal address, can be null</address>
<description>entity's description, can be null</description>
<status>entity's status, active, inactive, paused or cancelled</status>
<hosted>1 if the entity is hosted with LiveRail, 0 otherwise</hosted>
<type>type of the entity, internal use</type>

<contact_email>contact email for this entity</contact_email>
<built_in>1 if the entity is considered as a 3rd party ad source, 0 otherwise</built_in>
<site_url>The entity's website URL</site_url>
<category_id>main category ID for this entity</category_id>
<admap>existing AD map for this entity; can be null</admap>
<campaign_acceptance>how the entity accepts new orders, manually or automatically</campaign_acceptance>
<parent_campaign_acceptance>how the entity accepts new orders from its parent entity, manually or automatically</parent_campaign_acceptance>
<parent_id>The numerical ID of the parent entity</parent_id>
<marketplaces_availability>The availability for the marketplaces</marketplaces_availability>
<domain_policy>The permission policy for domains.</domain_policy>
<inte_truste_id>Truste numerical ID</inte_truste_id>
<inte_evidon_client_id>Evidon Client ID</inte_evidon_client_id>
<inte_evidon_campaign_id>Evidon Campaign ID</inte_evidon_campaign_id>
<inte_proximic_enabled>yes|no</inte_proximic_enabled>
<business_type> The business type</business_type>
<inte_afine_line_item_id>Afine line item ID</inte_afine_line_item_id>
<inte_safecount_campaign_id>Safecount campaign ID</inte_safecount_campaign_id>
<inte_safecountin_enabled>yes|no</inte_safecountin_enabled>
<inte_aperture_enabled>yes|no</inte_aperture_enabled>
<inte_doubleverify_campaign_id>DouleVerify Campaign ID</inte_doubleverify_campaign_id>
<inte_doubleverify_client_id>
<inte_doubleverify_behavior>R|B|RB</inte_doubleverify_behavior>
<inte_adxpose_id>AdXpose ID</inte_adxpose_id>
<inte_vizu_campaign_id>Vizu Campaign ID</inte_vizu_campaign_id>
<inte_vizu_agency_enabled>yes|no</inte_vizu_agency_enabled>
<inte_adsafe_enabled>Adsafe enabled: "yes" | "no"</inte_adsafe_enabled>
<inspector_enabled>yes|no</inspector_enabled>
<adsource_available>yes|no</adsource_available>
<realtime_dashboard_enabled>yes|no</realtime_dashboard_enabled>
<rtb_enabled>yes|no</rtb_enabled>
<inte_nielsen_client_id>Nielsen Client ID</inte_nielsen_client_id>
<inte_nielsen_password>Nielsen password</inte_nielsen_password>
<inte_nielsen_api_key>Nielsen API Key</inte_nielsen_api_key>
</entity>
</entities>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
14 May 2012
Added integrations
25 May 2012
Added auto_retarget, updated status values.
28 May 2012
Removed bid_optimization, moved to

/connection/list
21 July 2012
Added 2 more parameters
30 July 2012
Added 1 more inte parameter
10 September
2012
30 September
2012
04 December
2012

Added inte_adsafe_enabled
Added adsource_available,
realtime_dashboard_enabled
08 January 2013 Added rtb_enabled
Reason
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Method Name: /entity/resolve/name

Method Description
Simple method that returns the entity name of a given entity ID. You can specify
multiple entity IDs, separated by comma (,).
Parameters
Authentication
token yes
(received
after /login).
The entity's
ID for which
integer the
entity_id yes
entity_id=788
organization
name will be
returned.
Return
<liverailapi requested="/entity/resolve/name" api_version="X.Y.Z">
<entities>
<entity>
<organization>entity's organization name</organization>
</entity>
....
</entities>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/list/bychar

Method Description
List all the available entities by char.
Parameters
Authentication
string session token
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/list/bychar" api_version="X.Y.Z">
<list>
<no>number</no>
<char>char</char>
</list>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/add

Method Description
Demand side entities must contain child sites, or destinations for advertisers
campaigns. These site entities are required for assigning to order line items during
the trafficking process. Creating a new Site causes the Site to become a child
entity of the Network account.
Related Methods
There are 2 related methods for this method:
Parameters
Name
token
organization
business_type
perspective
address
contact_email
hosted
status
inspector_enabled
domain_policy
description
type
site_url
category_id
admap
connect_to_parent
parent_id

Example
string Authentication session
yes
token (received after /login).
yes
string The name of the new entity. organization=test123
The business type of the
entity. The accepted values
are: "advertiser", "agency",
"trading_desk", "dsp",
enum "ad_network",
yes
business_type=lrc_seller
"vertical_content_network",
"publisher",
"marketplace_buyer",
"lrc_seller".
The new entity can be
either another network or
publisher entity ( the
string supported values are N
no
perpective=P
(network), P (publisher), A
and M (market) ). If not
given, it defaults to N.
no
string The entity's mailing address address example
A contact email address or
addresses. Multiple
addresses can be used,
string separated by comma. This [email protected]
no
parameter is optional. If the
specified value is
"LR_API_NULL", the
integration will be cleared.
Specify if the entity is
hosted with LiveRail or not.
0 / 1 The accepted values are 1 hosted=0
no
or 0, with the default value
being 1.
The accepted values are
string "active" | "trial" | "paused" | status=trial
no
"cancelled" , with the default
value being "active".
"yes" | "no" with the default
enum value being "null". This
no
inspector_enabled=yes
parameter is optional and
available only to root users.
enum "allow" | "deny" with the
no
domain_policy=allow
default value being "deny".
This parameter is optional.
no
string The description of the entity description=This entity is newly created.
The type of the entity. In
string order to get the available type=xyz
no
types please use
no
string The site url.
url=www.testentity.com
The category of the entity.
string In order to get the available category_id=777
no
categories please use
Specify the existing AD map
string for this entity; it can also be admap=xyz
no
null.
Connect the entity to parent.
0 / 1 The accepted values are 1 connect_to_parent=0
no
or 0, with the default value
being 1.
The numerical ID for the
integer parent entity. This
no
parent_id=5478
built_in
no
0/1
campaign_acceptance
no
enum
parent_campaign_acceptance no
enum
has_truste
no
enum
has_evidon
no
enum
has_proximic
no
enum
has_affine
no
enum
has_safecount
no
enum
has_aperture
no
enum
has_doubleverify
no
enum
has_adxpose
no
enum
has_vizu
no
enum
has_adsafe
no
enum
has_nielsen
no
enum
has_exelate
no
enum
has_lotame
no
enum
parameter is optional.
considered as a 3rd party
ad source or not. The
built_in=1
accepted values are 1 or 0,
with the default value being
0.
Specify how will the entity
accept new orders:
manually or automatically.
The accepted values are:
automatically |
campaign_acceptance=manually
automatically_1h |
automatically_24h |
manually . The default value
is "automatically".
accept new orders from its
parent entity: manually or
automatically. The accepted
values are: automatically | parent_campaign_acceptance=manually
automatically_1h |
automatically_24h |
manually . The default value
is "automatically".
Specify is the entity has
Truste integration. The
accepted values are "yes" or has_truste=yes
"no".The default value is
null.
Evidon integration. The
accepted values are "yes" or has_evidon=yes
null.
Proximic integration. The
accepted values are "yes" or has_proximic=yes
null.
Affine integration. The
accepted values are "yes" or has_affine=yes
null.
SafeCount integration. The
accepted values are "yes" or has_safecount=yes
null.
Aperture integration. The
accepted values are "yes" or has_aperture=yes
null.
DoubleVerify integration.
has_doubleverify=yes
"yes" or "no".The default
value is null.
AdXpose integration. The
accepted values are "yes" or has_expose=yes
null.
Specify is the entity has Vizu
integration. The accepted
has_vizu=yes
values are "yes" or "no".The
default value is null.
AdSafe integration. The
accepted values are "yes" or has_adsafe=yes
null.
Nielsen integration. The
accepted values are "yes" or has_nielsen=yes
null.
Exelate integration. The
accepted values are "yes" or has_exelate=yes
null.
Lotame integration. The
accepted values are "yes" or has_lotame=yes
null.
Control the availability of the
ad sources. When set to
adsource_available
no
realtime_dashboard_enabled no
rtb_enabled
no
"no", the following actions:

creation and editing of ad
source connection,
enum scenarios and price floor
adsource_available=no
rules are not possible. The
accepted values are "yes"
and "no", with the default
value being "yes". This
parameter is available only
to the root users.
Control the visibility of real
time analytics. The
enum and "no", with the default realtime_dashboard_enabled=yes
value being "no". This
to the root users.
Control the Real Time
Bidding. The accepted
values are "yes" and "no",
enum with the default value being rtb_enabled=no
"yes". This parameter is
available only to the root
users.
Return
<liverailapi requested="/entity/add" api_version="X.Y.Z">
<entity_id>the numeric ID of the newly created entity</entity_id>
<my_campaigns_connection_id>self-connection as a publisher for the newly created entity</my_campaigns_connection_id>
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
14 May 2012
Added integrations
25 May 2012
Updated status with cancelled.
28 May 2012

/connection/add
21 July 2012
Added 2 more inte parameters
30 July 2012
10 September
2012
30 September
2012
04 December
2012

Reason
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Method Name: /entity/edit

Method Description
Edit the details of a given entity.
Related Methods
Parameters
Name
token
entity_id
organization
perspective
address
contact_email
hosted
status
inspector_enabled

string Authentication session token
yes
(received after /login).
integer The numerical ID of the
yes
entity to be edited.
no
string The new name of the entity.
The new perspective for the
entity ( the supported values
are N, P, A and M). This
string parameter is optional,
no
meaning that, if not given,
the parameter value is not
altered in any way.
string The entity's new mailing
no
address
A contact email address or
addresses. Multiple
addresses can be used,
separated by comma. This
parameter is optional,
string meaning that, if not given,
no
altered in any way. If the
specified value is
"LR_API_NULL", the
integration will be cleared.
Specify if the entity is hosted
with LiveRail or not. The
accepted values are 1 or 0.
0 / 1 This parameter is optional,
no
altered in any way.
The new status of the entity.
"active" | "trial" | "paused" |
string "cancelled". This parameter
no
is optional, meaning that, if
not given, the parameter
value is not altered in any
way.
"yes" | "no". This parameter
is optional, meaning that, if
enum not given, the parameter
no
way. It is available only to
root users.
"allow" | "deny" This
Example
entity_id=788
organization=test123
perpective=P
address example
[email protected]
hosted=0
status=trial
inspector_enabled=yes
domain_policy
no
description
no
type
no
site_url
no
category_id
no
admap
no
connect_to_parent
no
parent_id
no
built_in
no
campaign_acceptance
no
parent_campaign_acceptance no
enum parameter is optional,

domain_policy=allow
altered in any way.
string The new description of the description=This entity is newly created.
entity
The new type of the entity. In
order to get the available
types please use
string /entity/network/type/list. This type=xyz
altered in any way.
The new site url. This
string meaning that, if not given, url=www.testentity.com
altered in any way.
The new numerical ID
category of the entity. In
order to get the available
categories please use
string /entity/publisher/category/list. category_id=777
This parameter is optional,
altered in any way.
Specify the existing AD map
for this entity. This parameter
string is optional, meaning that, if admap=xyz
way.
Connect the entity to parent.
The accepted values are 1
0 / 1 or 0. This parameter is
connect_to_parent=0
optional, meaning that, if not
given, the parameter value is
not altered in any way.
The numerical ID for the
parent entity. This parameter
integer is optional, meaning that, if parent_id=6584
way.
considered as a 3rd party ad
source or not. The accepted
0 / 1 values are 1 or 0. This
built_in=1
altered in any way.
accept new orders: manually
or automatically. The
accepted values are:
automatically |
enum automatically_1h |
campaign_acceptance=manually
automatically_24h | manually
. This parameter is optional,
altered in any way.
accept new orders from its
parent entity: manually or
automatically. The accepted
values are: automatically |
enum automatically_1h |
parent_campaign_acceptance=manually
automatically_24h | manually
marketplaces_availability
no
set
domain_policy
no
set
has_truste
no
enum
has_evidon
no
enum
has_proximic
no
enum
has_affine
no
enum
has_safecount
no
enum
has_aperture
no
enum
. This parameter is optional,

altered in any way.
Specify the availability for
marketplaces. Possible
values are: "available",
"unavailable". This
altered in any way.
Specify the domain
permission policy. Possible
values are: "allow", "deny".
altered in any way.
Truste integration. The
accepted values are "yes" or
"no". The accepted values
are "yes" or "no". This
altered in any way.
Evidon integration. The
"no".The accepted values
altered in any way.
Proximic integration. The
altered in any way.
Affine integration. The
altered in any way.
SafeCount integration. The
altered in any way.
Aperture integration. The
marketplaces_availability=available
domain_policy=allow
has_truste=yes
has_evidon=yes
has_proximic=yes
has_affine=yes
has_safecount=yes
has_aperture=yes
has_doubleverify
no
enum
has_adxpose
no
enum
has_vizu
no
enum
has_adsafe
no
enum
has_nielsen
no
enum
has_exelate
no
enum
has_lotame
no
enum
adsource_available
no
enum
altered in any way.

DoubleVerify integration. The
has_doubleverify=yes
altered in any way.
AdXpose integration. The
has_expose=yes
altered in any way.
Specify is the entity has Vizu
integration. The accepted
values are "yes" or "no".The
has_vizu=yes
"no". This parameter is
AdSafe integration. The
has_adsafe=yes
altered in any way.
Nielsen integration. The
has_nielsen=yes
altered in any way.
Exelate integration. The
has_exelate=yes
altered in any way.
Lotame integration. The
has_lotame=yes
altered in any way.
Control the availability of the
ad sources. When set to
"no", the following actions:
creation and editing of ad
source connection,
scenarios and price floor
rules are not possible. The
adsource_available=no
and "no".This parameter is
realtime_dashboard_enabled no
rtb_enabled
no

not altered in any way. This
to the root users.
Control the visibility of real
time analytics. The accepted
values are "yes" and "no".
enum meaning that, if not given, realtime_dashboard_enabled=no
altered in any way. This
to the root users.
Control the Real Time
Bidding. The accepted
values are "yes" and "no".
enum meaning that, if not given, rtb_enabled=no
to the root users.
Return
<liverailapi requested="/entity/edit" api_version="X.Y.Z">
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
14 May 2012
Added integrations
25 May 2012
Updated status with cancelled.
28 May 2012

/connection/edit
21 July 2012
Added 2 more inte parameters
30 July 2012
10 September
2012
30 September
2012
04 December
2012

Reason
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Align with
API
Method Name: /entity/delete

Method Description
Deletes an existing entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
integer ID of the
entity_id yes
entity_id=788
entity to be
deleted.
Return
<liverailapi requested="/entity/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/exchange/list

Method Description
Returns the LRC entity.
Parameters
Authentication
session token
string
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/exchange/list" api_version="X.Y.Z">
<exchange>
<entity_id>the id of LRC</entity_id>
<parent_id>null if the entity is a root entity, parent's entity ID otherwise</parent_id>
...
</exchange>
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/publisher/category/list

Method Description
Returns the list of available category id(s).
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/publisher/category/list" api_version="X.Y.Z">
<exchange>
<categories>
<category>
<id>the id of the category</id>
<name>the name of the category</name>
</category>
...
</categories>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/network/type/list

Method Description
Lists the type(s) of entities.
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/network/type/list" api_version="X.Y.Z">
<types>
<type>
<id>the type</id>
<enabled_in>flag that tells if IN orders are supported; can be 0 or 1</enabled_in>
<enabled_ov>flag that tells if OV orders are supported; can be 0 or 1</enabled_ov>
</type>
...
</types>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/network/type/list

Method Description
Lists the type(s) of entities.
Related Methods
Network type retrieval:
To get the available network types, please use this link
Parameters
Example
Authentication session
string token (received after token=f5a81cdde43c6334feffcfc13ad53717
token yes
/login).
The type of the entity.
string To get the available type=ABCD
type yes
types please use
Return
<liverailapi requested="/entity/network/type/list" api_version="X.Y.Z">
<parameters>
<parameter>
<type>the type of the entity</type>
<code>the code of the parameter</code>
<name>the name of the parameter</name>
<description>the description of the parameter</description>
<value_type>the type of the parameter</value_type>
<required>flag that tells you if the parameter is required or not; if this flag is 1 then the parameter is required, if it's 0, the parameter is optional</required>
</parameter>
</parameters>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/integration/get

Method Description
Retrieve the available integrations for an entity.
Parameters
Example
Authentication
token yes
(received after
/login).
The numerical
ID of the entity
string for which the entity_id=7665
entity_id yes
integrations
are listed.
Return
<liverailapi requested="/entity/integration/get" api_version="X.Y.Z">
<integrations>
<integration>
<entity_id>The entity ID</entity_id>
<has_vizu>yes|no</has_vizu>
<has_adxpose>yes|no</has_adxpose>
<has_doubleverify>yes|no</has_doubleverify>
<has_aperture>yes|no</has_aperture>
<has_safecount>yes|no</has_safecount>
<has_affine>yes|no</has_affine>
<has_evidon>yes|no</has_evidon>
<has_truste>yes|no</has_truste>
<has_proximic>yes|no</has_proximic>
<has_adsafe>yes|no</has_adsafe>
<has_nielsen>yes|no</has_nielsen>
<has_exelate>yes|no</has_exelate>
<has_lotame>yes|no</has_lotame>
</integration>
</integrations>
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
22.01.2013
Description
Updated parameters in xml
Reason
Align with API
USERS
All the methods related to users are displayed here.

/user/add
/user/edit
/user/list
/user/delete
/user/settings/set
/user/settings/get
Method Name: /user/list

Method Description
List the users currently connected to the current selected entity or attached to
another entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical ID
of the entity for
which the users
will be listed. If
you have multiple
id(s) you can
make a single call
by glueing them
string together with | or , entity_id = 1|7|120 or entity_id = 1,7,120
entity_id
yes
This method will
not return users
that have
"inherited"
rights on the
entity, but only
users that have
DIRECT rights
on it.
The numerical ID
of the user to be
returned. If you
integer have multiple id(s) user_id = 1|7|120 or user_id = 1,7,120
user_id
no
you can make a
single call by
glueing them
together with | or ,
Optional, the
name of the user
string for which the
name
no
name=User123
details are
returned.,
Optional, the
email of the user
email
no
[email protected]
details are
returned.
Optional, specify
the user's role for
string which the details not_like_role=admin
not_like_role no
are NOT
returned.
Optional, search
based on the
enum email acceptance accept_emails=yes
accept_emails no
of the user. The
accepted values
are "yes", "no".
Run the search
string based on the
start_string no
start_string=Tel
users's first part
search_string no
limit
no
offset
no
of the name.
Optional, return
only the users
string with the name
search_string=cro
that are LIKE
%search_string%.
Limit the number
integer of results for
limit=10
pagination(s).
The offset from
where the limit
should be applied
( if you display 10
users per page
and you need to
get the 3rd page
integer you should set offset=20
offset to 20 and
limit to 10 ). This
parameter
shouldn't be given
without giving the
limit parameter as
well.
Return
<liverailapi requested="/user/list" api_version="X.Y.Z">
<users>
<user>
<id>user's ID</id>
<name>user's full name</name>
<email>user's email / login name</email>
<timezone>user's timezone (GMT offset)</timezone>
<accept_emails>yes or no, send or don't send e-mails to this user</accept_emails>
<admin>0|1</admin>
<entity_id></entity_id>
<role>user's account role</role>
</user>
...
</users>
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
Description
Reason
Method Name: /user/add

Method Description
Adds a new user or attaches an existing one to the current selected entity.
Parameters
Name
name

yes
string The user's login name.
string User's email address, used as
email
yes
a login name too.
MD5 hash format of the user's
string
password
yes
clear-text password. Must
contain at least 5 characters.
User's account role on the
current entity; admin string administrator, cust-rw role
no
customer read-write, cust-ro customer read-only. The
default value is "null"
current entity; admin float administrator, cust-rw timezone
no
current entity; admin enum administrator, cust-rw admin
no
current entity; admin float administrator, cust-rw commision
no
current entity; admin string administrator, cust-rw accept_emails no
User's status. The possible
enum
status
no
values are: active, trial. The
default value is "active"."
Return
Example
name=bbb
[email protected]
password=???
role=cust-rw
timezone=5
admin=1
commision
accept_emails=no
status=trial
<liverailapi requested="/user/add" api_version="X.Y.Z">

<user_id>the user ID of the newly created user</user_id>
<user> ... </user>
<auth> ... </auth>
...
returned only if status is fail.
Change History
Date
Description
Reason
Method Name: /user/edit

Method Description
Adds a new user or attaches an existing one to the current selected entity. Note:
to change the password for an user, use /user/recover/init followed by
/user/recover.
Parameters
Name
token
user_id
name
email

Authentication
yes
(received
after /login).
The
string numerical ID user_id=564
yes
of the user to
be edited.
The user's
login name.
This
parameter is
optional,
string meaning that, name=bbb
no
if not given,
the parameter
value is not
altered in any
way.
User's email
address, used
as a login
name too.
This
parameter is
string optional,
no
[email protected]
meaning that,
if not given,
the parameter
value is not
altered in any
way.
MD5 hash
format of the
user's cleartext
password.
Must contain
at least 5
characters.
string
password
no
timezone
no
accept_emails no
admin
no
string This
password=???
parameter is
optional,
meaning that,
if not given,
the parameter
value is not
altered in any
way.
User's
timezone.
This
parameter is
optional,
float meaning that, timezone=4
if not given,
the parameter
value is not
altered in any
way.
Specify if the
new user will
accept emails
or not. The
accepted
values are
"yes" , "no".
enum This
accept_email=yes
parameter is
optional,
meaning that,
if not given,
the parameter
value is not
altered in any
way.
Specify if the
new user will
be admin or
not. The
accepted
values are "0"
, "1". This
enum parameter is admin=1
optional,
meaning that,
if not given,
the parameter
value is not
altered in any
way.
User's status.
The possible
values are:
active, trial.
This
parameter is
enum
status
no
enum optional,
status=active
meaning that,
if not given,
the parameter
value is not
altered in any
way.
Return
<liverailapi requested="/user/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
Description
Reason
Method Name: /user/delete

Method Description
Delete an existing user.
Warning: from the customer's perspective, this method has the same
effect as /user/detach.
Parameters
Example
Authentication
token yes
(received after
/login).
The numeric
integer ID of the user user_id = 1752
user_id yes
to be deleted.
Return
<liverailapi requested="/user/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
Description
Reason
Method Name: /user/recover

Method Description
Change the password of an existing user.
Parameters
Name

Authentication
token
yes
(received
after /login).
User's email
string address, used [email protected]
email
yes
as a login
name too.
MD5 hash
format of the
user's clearstring text
password yes
password=???
password.
Must contain
at least 5
characters.
The
authorization
hash which is
part of the
string reset
hash
yes
hash=ext
password
link; last block
of characters
from the URI.
Return
<liverailapi requested="/user/recover" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
23 February 2012
Description
Method added
Reason
Method added in API.
Method Name: /user/recover/init

Method Description
Request a new password for an existing user. An e-mail with a confirmation link
will be sent to the user.
Parameters
Authentication
token yes
(received after
/login).
The e-mail
address of the
string user for which
email yes
you want to
change the
password.
Example
[email protected]
Return
<liverailapi requested="/user/recover/init" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
23 February 2012
Description
Method added
Reason
Method added in API.
Method Name: /user/settings/set

Method Description
Specify the settings for a particular user's numerical ID.
Parameters
string Specify the name. Names in format "3p_%"
name yes
are not allowed.
string Specify the value. If the value is specified as
value no
"LR_API_NULL", this setting will be cleared.
string Specify the settings for a particular user's
user_id no
numerical ID.
Example
name=lrtester
value=winter
user_id=5485
Return
<liverailapi requested="/user/settings/set" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Method added to API
18.01.2012
tester/documentation
Reason
Method needed to allow 3rd party
integrations based on settings table.
Method Name: /user/settings/get

Method Description
List the specific user settings.
Parameters
Example
string Display all the settings attached to a specific user_id=5485
user_id no
user numerical ID.
string Search for the user's exact name. Partial
name no
name=lrtester
matches will not be accepted.
Return
<liverailapi requested="/user/settings/get" api_version="X.Y.Z">
<settings>
<setting>
<user_id>974</user_id>
<name>brindusatest</name>
<value>the defined value, if any</value>
</setting>
...
</settings>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Method added to API
18.01.2012
tester/documentation
Reason
Method needed to allow 3rd party
integrations based on settings table.
ENTITY USERS
All the methods related to entity users are displayed here.

/entity/user/list
/user/attach
/user/detach
Method Name: /entity/user/list

Method Description
Returns the complete list of users that have rights on the given entity.
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/user/list" api_version="X.Y.Z">
<users>
<user>
<user_id>the id of the user</user_id>
<email>the user's email</email>
<accept_emails>flag that tells the system if the user accepts emails; can be 'yes' or 'no'</accept_emails>
<role>the role of the user</role>
<inherited>flag that tells if the role on this entity is inherited from a parent entity or not; can be 1 ( the role is inherited ) or 0 ( the role is specified for this entity )</inherited>
</user>
...
</users>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /user/attach

Method Description
Attach an existing user to an entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
ID of the
integer entity to
entity_id yes
entity_id = 225
which the
user will be
attached.
The numeric
user_id yes
to be
attached.
User's
account role
on the entity;
admin administrator,
string cust-rw role
yes
role=admin
customer
read-write,
cust-ro customer
read-only
Return
<liverailapi requested="/user/attach" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
Description
Reason
Method Name: /user/detach

Method Description
Detach an existing user from an entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
ID of the
integer entity from entity_id = 225
entity_id yes
which the
user will be
detached.
The numeric
user_id yes
to be
detached.
Return
<liverailapi requested="/user/detach" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
Change History
Date
Description
Reason
ENTITY CATEGORIES
All the methods related to entity categories are displayed here.

/entity/category/domain/add
/entity/category/domain/edit
/entity/category/domain/list
Method Name: /entity/category/domain/list

Method Description
List all the available domains for a given entity.
Parameters
Name
Required Type
token
yes
entity_id
not
domain
no
category
no
domain_search no
category_search no
status
no
approved_after no
search_string
no
source
no
Overview
Example
Authentication
session token
string
(received after
/login).
Search for a
domain with a
specific numerical
ID. If you have
string
multiple id(s) you entity_id=788,333
can make a single
call by glueing
them together
with | or ,
Search for a
domain with a
string
specific name.
domain=context.com
This paramenter
is optional.
Search for a
string
category with a category=music
specific name.
Return only the
domains with the
name that are
string
LIKE
domain_searc=cont
%search_string%.
This paramenter
is optional.
Return only the
categories with
the name that are
string
LIKE
category_search=mus
%search_string%.
This paramenter
is optional.
Display the
status. This
string
status=...
paramenter is
optional.
Return only the
entries that are
newer than the
DateTime specified date
approved_after=10.10.2012 00:00:00
and time. This
paramenter is
optional.
Return only the
domains and
categories with
string
search_string=tras
the name that are
LIKE
%search_string%.
Return only the
domains and
categories with
the specified
enum
source. Possible source=user
values: "system'
"user". This
parameter is
optional.
Return only the
domains and
categories with
the specified
quality. Possible
values: "Premium"
quality
no
string
"Prosumer"
"RON". If you
quality=Premium,RON
have multiple
values, you can
make a single call
by glueing them
This parameter is
optional.
Return
<liverailapi requested="/entity/category/domain/list" api_version="X.Y.Z">
<domains>
<domain>
<domain_name>The name of the domain</domain_name>
<entity_id>The numerical ID of the corresponding entity</entity_id>
<categories>
<category>
<category_id></category_id>
<parent_category_id></parent_category_id>
<category_name></category_name>
</category>
...
</categories>
<entity_domain_id>The numerical ID of the domain</entity_domain_id>
<duration></duration>
<autoplay></autoplay>
<quality>Premium|Prosumer|RON or NULL</quality>
<companions></companions>
<audio></audio>
<content></content>
<floor></floor>
<above></above>
<player></player>
<ts>Start time and date</ts>
<approved_ts></approved_ts>
<inv></inv>
<status>Status of the domain (possible values are: new, pending, approved, not_approved)</status>
<pitch>Pitch of the domain</pitch>
<avg_daily_inv></avg_daily_inv>
<estimate_monthly_volume></estimate_monthly_volume>
<ad_unit_types>The ad unit types</ad_unit_types>
<platform></platform>
<content_duration></content_duration>
<content_type></content_type>
<player_url></player_url>
<min_cpm></min_cpm>
<notes></notes>
<not_approved_reason></not_approved_reason>
<source>system|user</source>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
31 August 2012
Description
New parameter added: source
Reason
Align with API
Method Name: /entity/category/domain/add

Method Description
Add a new domain for a given entity.
Parameters
Name
token
entity_id
name
estimate_monthly_volume_us
min_cpm_us_instream
min_cpm_us_in_banner
min_cpm_us_overlay
player_url
ad_unit_types
placement
above
companions

Example
Authentication
yes
(received after
/login).
The numerical ID of
integer the entity to which entity_id=123
yes
the new domain will
be added.
string The name of the
yes
name=testdomain
new domain.
The estimated
float monthly traffic
yes
estimate_monthly_volume_us=2.23
volume for USA.
Specify for USA: the
float minimum CPM
yes
min_cpm_us_instream=5.1
accepted for this
domain on Instream.
float minimum CPM
yes
min_cpm_us_in_banner=6.1
accepted for this
domain on InBanner
minimum CPM
float
yes
min_cpm_us_overlay=1.2
accepted for this
domain on Overlay.
string Specify the player player_url=www.test.com
yes
url.
Specify the type of
the Ad unit.
set
yes
Accepted values
ad_unit_types=midroll
are: "preroll" |
"midroll" | "postroll".
Specify the
placement of the Ad.
Accepted values
are: Accepted
set
yes
placement=In-Banner
values are: "InStream" | "overlay" |
"In-Banner",
"Interstitial".
Specify if the player
is above or below
set
yes
the fold. The
above=no
accepted values
are: "yes" | "no".
Specify the size of
the companions.
The accepted
values are: "728x90"
set
yes
companions="728x90"
| "300x600" |
"300x250"
|"160x600" |
"180x150".
Specify the type of
autoplay
yes
audio
yes
category_id
yes
content_duration
yes
duration
yes
pitch
avg_daily_inv
no
no
estimate_monthly_volume_non_us no
estimate_monthly_volume_uk
no
estimate_monthly_volume_au
no
estimate_monthly_volume_ca
no
targeting_strengths
no
other_platform
no
the video content

play: autoplay or
set
user-initiated. The autoplay=Auto Play
accepted values:
are "Auto Play" |
"Click to Play".
Specify whether the
video content will
initiate with audio on
set
audio=sound-on
or off. The accepted
values are: "soundon" | "sound-off".
The numeric ID of
the category (s) to
which the new
domain will be
added. A warning
message* will be
given if one or more
integer of the numerical IDs category_id=123
is incorrect. If all IDs
are incorrect, the
domain will not be
added. Multiple IDs
can be specified,
separated by pipe (
| ).
Specify the content
duration on the
website. The
set
content_duration=live
accepted values
are: "short" | "long" |
"game" | "live".
Specify the
maximum video ad
duration limit in
set
seconds. The
duration=60
accepted values
are: "15" | "30" | "60"
| "no_limit".
string The pitch
pitch=???
string ...
avg_daily_inv=???
Specify for others:
float the estimated
estimate_monthly_volume_non_us=4.2
monthly traffic
volume.
Specify for United
float Kingdom: the
estimate_monthly_volume_uk=4.2
estimated monthly
traffic volume.
Specify for Australia:
float the estimated
monthly traffic
volume.
Specify for Canada:
float the estimated
estimate_monthly_volume_ca=4.2
monthly traffic
volume.
The target
audience. Accepted
set
targeting_strengths=male
values are: "male" |
"female".
Specify the platform,
if operating on other
platforms. The
set
other_platform=tv
accepted values
are: "iptv", "mobile",
"game", "tv".
Specify the video
platform
no
player
no
aspect_ratio
no
restricted_advertising
no
min_cpm_uk_instream
no
min_cpm_uk_overlay
no
player
technology/platform
the site operates on.
The accepted
values are:
"Brightcove",
"Castfire", "Delve",
"FlowPlayer", "JW
Player", "Kaltura",
"Kickapps", "OMSF",
"Ooyala",
"ThePlatform",
set
platform=Ooyala
"Twistage", "Unicorn
Media", "Viddler",
"Custom AS3
Player(LiveRail
Integration)",
"Custom AS3
Player(VAST
Compliant)",
"Custom AS3
Player(VAST+VPAID
Compliant)",
"Custom HTML5
Player", "Interstitial".
Specify the video or
game player
width(s). The
accepted values
set
are: "small" (300 to player=small
480) | "medium"
(480 to 640) |
"large" (640 and
above).
game player aspect
set
ratio(s). The
aspect_ratio=16:9
accepted values
are: "16:9" | "4:3".
Specify the
restricted types of
advertising,
advertisers, or
networks. The
accepted values
are: 'Alcohol',
'Dietary
Supplements',
string 'Firearms', 'Land- restricted_advertising=Political
based Casinos',
'Online Gambling',
'Political',
'Prescription Drugs',
'Religion', 'Sexual
Content',
'Sweepstakes
Contests', 'Tobacco',
'Violence','Interactive
Ads (VPAID)'
Specify for United
Kingdom: the
float minimum CPM
min_cpm_uk_instream=7.2
accepted for this
domain on Instream.
Specify for United
Kingdom: the
float minimum CPM
min_cpm_uk_overlay=7.2
accepted for this
domain on Overlay.
Specify for United
min_cpm_uk_in_banner
no
float
min_cpm_au_instream
no
float
min_cpm_au_overlay
no
float
min_cpm_au_in_banner
no
float
min_cpm_ca_instream
no
float
min_cpm_ca_overlay
no
float
min_cpm_ca_in_banner
no
float
min_cpm_other_instream
no
float
min_cpm_other_overlay
no
float
min_cpm_other_in_banner
no
float
Kingdom: the
minimum CPM
min_cpm_uk_in_banner=7.2
accepted for this
domain on InBanner.
the minimum CPM
min_cpm_au_instream=7.2
accepted for this
domain on Instream.
the minimum CPM
min_cpm_au_overlay=7.2
accepted for this
domain on Overlay.
the minimum CPM
min_cpm_au_in_banner=7.2
accepted for this
domain on InBanner.
Specify for Canada:
the minimum CPM
min_cpm_ca_instream=7.2
accepted for this
domain on Instream.
Specify for Canada:
the minimum CPM
min_cpm_ca_overlay=7.2
accepted for this
domain on Overlay.
Specify for Canada:
the minimum CPM
min_cpm_ca_in_banner=7.2
accepted for this
domain on InBanner.
Specify for others:
the minimum CPM
min_cpm_other_instream=7.2
accepted for this
domain on Instream.
Specify for others:
the minimum CPM
min_cpm_other_overlay=7.2
accepted for this
domain on Overlay.
Specify for others:
the minimum CPM
min_cpm_other_in_banner=7.2
accepted for this
domain on InBanner.
Return
<liverailapi requested="/entity/category/domain/add" api_version="X.Y.Z">
*<warnings>
<warning>The numerical ID of the invalid category</warning>
</warnings>
<entity_domain_id>The numerical ID of the newly created domain</entity_domain_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/category/domain/edit

Method Description
Edit an existing domain for a given entity.
Parameters
Name
token
entity_domain_id
name
estimate_monthly_volume_us
min_cpm_us_instream
min_cpm_us_in_banner
min_cpm_us_overlay
player_url
ad_unit_types
placement
above
companions

Example
Authentication
yes
(received after
/login).
The numerical ID of
integer the entity to which entity_domain_id=123456
yes
the new domain will
be added.
string The name of the
no
name=testdomain
new domain.
The estimated
float monthly traffic
no
estimate_monthly_volume_us=2.23
volume for USA.
float minimum CPM
no
min_cpm_us_instream=5.1
accepted for this
domain on Instream.
float minimum CPM
no
min_cpm_us_in_banner=6.1
accepted for this
domain on InBanner
minimum CPM
float
no
min_cpm_us_overlay=1.2
accepted for this
domain on Overlay.
string Specify the player player_url=www.test.com
no
url.
Specify the type of
the Ad unit.
set
no
Accepted values
ad_unit_types=midroll
are: "preroll" |
"midroll" | "postroll".
Specify the
placement of the Ad.
Accepted values
are: Accepted
set
no
placement=In-Banner
values are: "InStream" | "overlay" |
"In-Banner",
"Interstitial".
Specify if the player
is above or below
set
no
the fold. The
above=no
accepted values
are: "no" | "no".
Specify the size of
the companions.
The accepted
values are: "728x90"
set
no
companions="728x90"
| "300x600" |
"300x250"
|"160x600" |
"180x150".
Specify the type of
autoplay
no
audio
no
category_id
no
content_duration
no
duration
no
pitch
avg_daily_inv
no
no
estimate_monthly_volume_non_us no
estimate_monthly_volume_uk
no
estimate_monthly_volume_au
no
estimate_monthly_volume_ca
no
targeting_strengths
no
other_platform
no
the video content

play: autoplay or
set
user-initiated. The autoplay=Auto Play
accepted values:
are "Auto Play" |
"Click to Play".
Specify whether the
video content will
initiate with audio on
set
audio=sound-on
or off. The accepted
values are: "soundon" | "sound-off".
The numeric ID of
the category (s) to
which the domain
will be added. A
warning message*
will be given if one
or more of the
integer numerical IDs is
category_id=123
incorrect. If all IDs
are incorrect, the
domain will not be
added. Multiple IDs
can be specified,
separated by pipe (
| ).
Specify the content
duration on the
website. The
set
content_duration=live
accepted values
are: "short" | "long" |
"game" | "live".
Specify the
maximum video ad
duration limit in
set
seconds. The
duration=60
accepted values
are: "15" | "30" | "60"
| "no_limit".
string The pitch
pitch=???
string ...
avg_daily_inv=???
Specify for others:
float the estimated
estimate_monthly_volume_non_us=4.2
monthly traffic
volume.
Specify for United
float Kingdom: the
estimated monthly
traffic volume.
float the estimated
monthly traffic
volume.
Specify for Canada:
float the estimated
estimate_monthly_volume_ca=4.2
monthly traffic
volume.
The target
audience. Accepted
set
targeting_strengths=male
values are: "male" |
"female".
Specify the platform,
if operating on other
platforms. The
set
other_platform=tv
accepted values
are: "iptv", "mobile",
"game", "tv".
Specify the video
platform
no
player
no
aspect_ratio
no
restricted_advertising
no
min_cpm_uk_instream
no
min_cpm_uk_overlay
no
player
technology/platform
the site operates on.
The accepted
values are:
"Brightcove",
"Castfire", "Delve",
"FlowPlayer", "JW
Player", "Kaltura",
"Kickapps", "OMSF",
"Ooyala",
"ThePlatform",
set
platform=Ooyala
"Twistage", "Unicorn
Media", "Viddler",
"Custom AS3
Player(LiveRail
Integration)",
"Custom AS3
Player(VAST
Compliant)",
"Custom AS3
Player(VAST+VPAID
Compliant)",
"Custom HTML5
Player", "Interstitial".
game player
width(s). The
accepted values
set
are: "small" (300 to player=small
480) | "medium"
(480 to 640) |
"large" (640 and
above).
game player aspect
set
ratio(s). The
aspect_ratio=16:9
accepted values
are: "16:9" | "4:3".
Specify the
restricted types of
advertising,
advertisers, or
networks. The
accepted values
are: 'Alcohol',
'Dietary
Supplements',
string 'Firearms', 'Land- restricted_advertising=Political
based Casinos',
'Online Gambling',
'Political',
'Prescription Drugs',
'Religion', 'Sexual
Content',
'Sweepstakes
Contests', 'Tobacco',
'Violence','Interactive
Ads (VPAID)'
Specify for United
Kingdom: the
float minimum CPM
min_cpm_uk_instream=7.2
accepted for this
domain on Instream.
Specify for United
Kingdom: the
float minimum CPM
min_cpm_uk_overlay=7.2
accepted for this
domain on Overlay.
Specify for United
min_cpm_uk_in_banner
no
float
min_cpm_au_instream
no
float
min_cpm_au_overlay
no
float
min_cpm_au_in_banner
no
float
min_cpm_ca_instream
no
float
min_cpm_ca_overlay
no
float
min_cpm_ca_in_banner
no
float
min_cpm_other_instream
no
float
min_cpm_other_overlay
no
float
min_cpm_other_in_banner
no
float
Kingdom: the
minimum CPM
min_cpm_uk_in_banner=7.2
accepted for this
domain on InBanner.
the minimum CPM
min_cpm_au_instream=7.2
accepted for this
domain on Instream.
the minimum CPM
min_cpm_au_overlay=7.2
accepted for this
domain on Overlay.
the minimum CPM
min_cpm_au_in_banner=7.2
accepted for this
domain on InBanner.
Specify for Canada:
the minimum CPM
min_cpm_ca_instream=7.2
accepted for this
domain on Instream.
Specify for Canada:
the minimum CPM
min_cpm_ca_overlay=7.2
accepted for this
domain on Overlay.
Specify for Canada:
the minimum CPM
min_cpm_ca_in_banner=7.2
accepted for this
domain on InBanner.
Specify for others:
the minimum CPM
min_cpm_other_instream=7.2
accepted for this
domain on Instream.
Specify for others:
the minimum CPM
min_cpm_other_overlay=7.2
accepted for this
domain on Overlay.
Specify for others:
the minimum CPM
min_cpm_other_in_banner=7.2
accepted for this
domain on InBanner.
Return
<liverailapi requested="/entity/category/domain/edit" api_version="X.Y.Z">
*<warnings>
<warning>The numerical ID of the invalid category</warning>
</warnings>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY DOMAIN LIST
All the methods related to entity domain lists are displayed here.
/entity/domain/list/add
/entity/domain/list/edit
/entity/domain/list/list
/entity/domain/list/delete
/entity/domain/list/resolve/name
/entity/domain/list/clear/list
/entity/domain/list/duplicate/list
Method Name: /entity/domain/list/list

Method Description
List the details for one or more domain lists from an entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical
ID(s) of the lists
for which the
details will be
string listed. If you have entity_domain_list_id=11,35
entity_domain_list_id yes
multiple ID(s) you
can make a single
call by glueing
them together
with | or ,
string Search based on list_name=test123000
list_name
no
the list name.
integer Search based on entity_id=8765
entity_id
no
the entity_id
Return only the
domain lists with
string the name that are search_string=test
search_string
no
LIKE
%search_string%.
Return
<liverailapi requested="/entity/domain/list/list" api_version="x.y.z">
<domain_lists>
<domain_list>
<entity_domain_list_id>The numerical ID of the list </entity_domain_list_id>
<entity_id>The numerical ID of the entity </entity_id>
<list_name>The name of the list</list_name>
<description>The description of the list</description>
<domain_count>Number or domains</domain_count>
</domain_list>
</domain_lists>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
02.10.2012
Description
Added search_string
Reason
Align with API
Method Name: /entity/domain/list/add

Method Description
Add a new domain list to an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The name of
string the new
list_name yes
list_name=test123
domain list.
The
string description of description=a test list
description no
the domain
list
The numeric
ID of the
string entity to
entity_id no
entity_id=452
which the
domain list
will be added
Return
<liverailapi requested="/entity/domain/list/add" api_version="X.Y.Z">
<entity_domain_list_id>The numerical ID of the newly created list.</entity_domain_list_id>
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/list/edit

Method Description
Edits a domain list.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
string numerical ID entity_domain_list_id=11
of the list to
be edited.
The new
name of the
list. This
parameter is
string mandatory if list_name=test123000
list_name
no
there is no
new
description
specified.
The new
description of
the list. This
parameter is
string mandatory if description=another test list
description
no
there is no
new
list_name
specified.
Return
<liverailapi requested="/entity/domain/list/edit" api_version="X.Y.Z">
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/list/delete

Method Description
Delete a domain list.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
of the list to
be deleted.
Return
<liverailapi requested="/entity/domain/list/delete" api_version="x.y.z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/list/resolve/name

Method Description
Return the list name based on its numerical ID.
Parameters
Name

Authentication
token
yes
(received
after /login).
Specify the
numerical
ID(s) of the
list for which
the name will
be returned. If
entity_domain_list_id = 1|7|120 or
string you have
entity_domain_list_id = 1,7,120
multiple ID(s)
you can make
a single call
by glueing
them together
with | or ,
Return
<liverailapi requested="/entity/domain/list/resolve/name" api_version="x.y.z">
<domain_lists>
<domain_list>
<entity_domain_list_id>The numerical ID of the list</entity_domain_list_id>
<list_name>The name of the list</list_name>
</domain_list>
</domain_lists>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/clear/list

Method Description
Delete all the domains from a domain list.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string of the list that entity_domain_list_id=11
will be
cleared.
Return
<liverailapi requested="/entity/domain/clear/list" api_version="x.y.z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/list/duplicate/list

Method Description
Duplicate the list, including all its domains.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
of the list to
be duplicated.
Return
<liverailapi requested="/entity/domain/list/duplicate/list" api_version="x.y.z">
<domain_list>
<entity_domain_list_id>The numerical ID of the duplicate list.</entity_domain_list_id>
</domain_list>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY DOMAIN LIST DOMAINS
All the methods related to entity domain list domains are displayed here.
/entity/domain/list/domain/add
/entity/domain/list/domain/list
/entity/domain/list/domain/delete
Method Name: /entity/domain/list/domain/list

Method Description
List the details for one or more domains from one or more list(s) in an entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical ID(s)
of the lists for which
the details will be
listed. If you have
multiple ID(s) you
can make a single
call by glueing them
together with | or , (
string examples: if you
entity_domain_list_id=58447
need to get the
information for list
ID(s) 1, 7 and 120
you can use
entity_domain_list_id
= 1|7|120 or
entity_domain_list_id
= 1,7,120 ).
string Search based on the domain_name=test123.com
domain_name
no
domain name.
Return only the
string domains with the
search_string
no
domain_name=test123
name that are LIKE
%search_string%.
Return
<liverailapi requested="/entity/domain/list/domain/list" api_version="X.Y.Z">
<domains>
<domain>
<entity_domain_list_id>The numerical ID of the list </entity_domain_list_id>
<domain_name>The name of the domain</domain_name>
</domain>
...
</domains>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/list/domain/add

Method Description
Add one or more new domain(s) to a list of domains on an entity.
Parameters
Name

Example
string token (received after
token
yes
/login).
The numerical ID of the list
string to which the new domain(s) entity_domain_list_id=58447
is(are) added.
The name of the domain(s)
to be added on the list. If
you have multiple domains
you can make a single call
by glueing them together
with | or , (examples: if you
string need to add the following domain_name=test123.com
domain_name
yes
domains test1.ro, test2.com
and test2.net you can use
domain_name =
test1.ro|test2.com|test2.net
or domain_name =
test1.ro,test2.com,test2.net)
Return
<liverailapi requested="/entity/domain/list/domain/add" api_version="X.Y.Z">
<inserted_domains>The number of the domains inserted</inserted_domains>
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/list/domain/delete

Method Description
Delete one or more new domain(s) from a list of domains on an entity.
Parameters
Name

Example
token
yes
/login).
The numerical ID of the list
string from which the domain(s) entity_domain_list_id=58447
is(are) removed.
The name of the domain(s)
to be deleted from the list. If
you have multiple domains
you can make a single call
by glueing them together
with | or , (examples: if you
string need to delete the following domain_name=test123.com
domain_name
yes
domains test1.ro, test2.com
and test2.net you can use
domain_name =
test1.ro|test2.com|test2.net
or domain_name =
test1.ro,test2.com,test2.net)
Return
<liverailapi requested="/entity/domain/list/domain/delete" api_version="X.Y.Z">
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY DOMAIN GEO
All the methods related to Entity Domain Geo are displayed here.
/entity/domain/geo/list
/entity/domain/geo/distinct/vertical/list
Method Name: /entity/domain/geo/list

Method Description
List the distict verticals based on geo entry of a specific domain(s).
Parameters
Name

Example
Authentication
session
token
string
token
yes
Search based on the numerical ID of
the entity. When specified, the
grouping will be done by domain and
entity_id. If you have multiple ID(s)
integer you can make a single call by glueing entity_id=687
entity_id
no
them together with | or , ( examples: if
you need to get the information for
entity ID(s) 1, 7 and 120 you can use
entity_id = 1|7|120 or entity_id =
1,7,120 ).
All the entity IDs specified here will
not be displayed in the result array. If
you have multiple ID(s) you can make
a single call by glueing them together
integer with | or , ( examples: if you do not not_entity_id=3547,474
not_entity_id
no
need to get the information for entity
ID(s) 3, 18 and 530 you can use
entity_id = 3|18|530 or entity_id =
3,18,530 ).
vertical_id
no
integer Search based on vertical ID.
vertical_id=18
All the vertical IDs specified here will
not be displayed in the result array. If
you have multiple ID(s) you can make
integer with | or , ( examples: if you do not not_vertical_id=3547,474
not_vertical_id no
need to get the information for vertical
ID(s) 3, 18 and 530 you can use
no_vertical_id = 3|18|530 or
not_vertical_id = 3,18,530 ).
string Search based on the domain's
domain
no
domain=test
complete name.
string Search based on the domain's
country_code
no
country_code=RO
country code.
All the country codes specified here
will not be displayed in the result
array. If you have multiple code(s)
you can make a single call by glueing
string them together with | or , ( examples: if not_country_code=DE
not_country_code no
you do not need to get the
information for country code(s) US,
FR and RO you can use
not_country_code = US|FR|RO or
not_country_code = US,FR,RO ).
region
no
string Search based on the domain's region. region=CA
All the regions specified here will not
be displayed in the result array. If you
have multiple region(s) you can make
with | or , ( examples: if you do not
need to get the information for
string region(s) NEWSOUTHWALES
not_region
no
not_region=CLUJ
ARIZONA and CLUJ you can use
not_region =
metro
no
string
not_metro
no
string
domain_search
no
string
return_type
no
enum
Return
NEWSOUTHWALES|ARIZONA|CLUJ
or not_region =
NEWSOUTHWALES,ARIZONA,CLUJ
)..
Search based on the domain's metro. metro=Los Angeles
All the metros specified here will not
be displayed in the result array. If you
have multiple metro(s) you can make not_metro=NEWYORK
with | or , .
Search based on th estring contained
by the domain name. The search will
domain_search=media
be performed in all entries or only in
the specified entity_id.
Specify the return type. The
supported values are: all (returns
individual data and summed data),
no-total (returns only individual data),
total (returns only summed data), bigreturn_type=no-total
total (returns only the total grouped
by domain), country-aggregation
(returns only the aggregated data
from each country). The default value
is: "all".
**There are 3 distinct cases for usage
of the entity_id, vertical_id and
non_vertical_id. Assume that entity_id
= 1,2,3 vertical_id=10,11,12,13,14,15
not_entity_id=4,5. vertical_id 10 and
13 are attached to entity_id 1 and
vertical_id 10 is also attached to
entity_id 2. - When calling only
entity_id=1,2 the result will display
the information for entity_id=1 and
vertical_id=10,13. - When calling
entity_id=1,2,3 and vertical_id are in
the same request, the result will
display the information for entity_id=2
and vertical_id=10. - When entity_id,
vertical_id and not_entity_id are in
the same request, the result will
display the information for entity_id=3
and not_entity_id=4,5. When
removing the entity_id from the
request, the result will display
vertical_id=10,11,12,13,14,15 and
not_entity_id=4,5
In addition, the call will automatically
detect matches between the location
parameters ( country_code, region
and metro ) and instead of simply
using the conditions glued together
by ANDs, it will create a condition set
glued by ORs which ensures that the
displayed result will not be generated
by mutually exclusive parts. Country
codes that do not correspond to the
regiond and/or metro will be filtered
by the call matching system and only
the correct matches will be grouped
together by "AND". For example,
specifying the following parameters:
country_code=FR,RO
region=CALIFORNIA,CLUJ will trigger
the results from the pair RO and
CLUJ, along with the results from FR
and the results from CALIFORNIA
(grouped by "OR").
<liverailapi requested="/entity/domain/geo/list" api_version="X.Y.Z">

<domains>
<domain>
<entity_id>The numerical ID of the entity</entity_id>
<vertical_id>The numerical ID of the vertical</vertical_id>
<data>JSON Array</data>
<ts>Time stamp</ts>
<domain>The name of the domain.</domain>
<country_code>Country Code</country_code>
<region>Region</region>
<metro>Metro</metro>
</domain>
...
</domains>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
17 May 2012
13 July 2012
Description
Added method into help file
Added country-aggregation, not- parameters
Reason
Align with API
Align with API
Method Name: /entity/domain/geo/distinct/vertical/list

Method Description
List the geo entry of a specific domain(s).
Parameters
Authentication
token yes
(received
after /login).
Search based
on the
numerical ID
of the entity. If
you have
multiple ID(s)
you can make
a single call
by glueing
them together
integer with | or , ( entity_id=687
entity_id no
examples: if
you need to
get the
information
for entity ID(s)
1, 7 and 120
you can use
entity_id =
1|7|120 or
entity_id =
1,7,120 ).
Return
<liverailapi requested="/entity/domain/geo/distinct/vertical/list" api_version="X.Y.Z">
<verticals>
<vertical>
</vertical>
...
</verticals>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
13 July 2012
Description
Added method into help file
Reason
Align with API
ENTITY DOMAIN FREQUENCY
All the methods related to entity domain frequency are displayed here.
/entity/domain/frequency/list
Method Name: /entity/domain/frequency/list

Method Description
Returns the list of entity domain frequency.
Parameters
Name

Authentication
token
yes
(received
after /login).
Optionally,
integer the domain entity_domain_id=11875
entity_domain_id no
ID.
Return
<liverailapi requested="/entity/domain/frequency/list" api_version="x.y.z">
<frequencies>
<frequency>
<entity_domain_frequency_id>Frequency Domain ID</entity_domain_frequency_id>
<entity_domain_id>Domain ID</entity_domain_id>
<frequency>Numerical value</frequency>
<percentage>percentage value</percentage>
<ts>2time stamp</ts>
</frequency>
...
</frequencies>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY DOMAIN AUDIENCE
All the methods related to entity domain audience are displayed here.
/entity/domain/audience/add
/entity/domain/audience/edit
/entity/domain/audience/list
/entity/domain/audience/delete
Method Name: /entity/domain/audience/list

Method Description
List the audience entry of a specific domain(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
Search based
on the domain
integer audience
entity_domain_audience_segment_id yes
entity_domain_audience_segment_id=3548
segment
numerical ID.
Search based
integer on the entity entity_domain_id=3548
entity_domain_id
yes
domain
audience_segment_id
yes
numerical ID
Search based
on the
integer audience
audience_segment_id=8877655
segment
numerical ID.
Return
<liverailapi requested="/entity/domain/audience/list" api_version="X.Y.Z">
<entity_domain_audience_segments>
<entity_domain_audience_segment>
<entity_domain_audience_segment_id>The numerical ID of the entity domain audience segment</entity_domain_audience_segment_id>
<entity_domain_id>The numerical ID of the entity domain </entity_domain_id>
<audience_segment_id>The numerical ID of the audience segment</audience_segment_id>
<percentage>The percentage.</percentage>
</entity_domain_audience_segment>
...
</entity_domain_audience_segments>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/audience/add

Method Description
Add an entity domain segment entry.
Parameters
Name
Required Type
token
yes
entity_domain_id
yes
audience_segment_id yes
percentage
yes
Overview Example
Authentication
(received
after /login).
The
numerical ID
of the entity
integer domain for entity_domain_id=3548
which the
audience is
added.
The
numerical Id
integer of the
audience_segment_id=8877655
segment to be
added.
percent ...
percentage=76%
Return
<liverailapi requested="/entity/domain/data/add" api_version="X.Y.Z">
<entity_domain_audience_segment_id>The numerical ID of the new audience.</entity_domain_audience_segment_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/audience/edit

Method Description
Edits an entity domain segment entry.
Parameters
Name
Required Type
token
yes
percentage
no
Overview Example
Authentication
(received
after /login).
The
numerical ID
of the entity
integer domain
entity_domain_audience_segment_id=3548
segment for
which the
audience is
edited.
percent ...
percentage=76%
Return
<liverailapi requested="/entity/domain/data/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/audience/delete

Method Description
Delete an entity domain segment entry.
Parameters
Name

Authentication
session token
string
token
yes
(received
after /login).
The
numerical ID
integer of the entity entity_domain_audience_segment_id=3548
domain
segment to be
deleted.
Return
<liverailapi requested="/entity/domain/data/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY MARKETPLACE
All the methods related to entity marketplace are displayed here.

/entity/marketplace/list
/entity/marketplace/margin/list
/entity/marketplace/margin/set
Method Name: /entity/marketplace/list

Method Description
Get the list of advertiser(s).
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/marketplace/list" api_version="X.Y.Z">
<marketplaces>
<marketplace>
<entity_marketplace_id>The numeric ID of the marketplace</entity_marketplace_id>
<entity_id>The numeric ID of the entity</entity_id>
<marketplace_name>The name of the marketplace</marketplace_name>
<marketplace_description>Description of the marketplace</marketplace_description>
<marketplace_logo>The name of the marketplace's logo</marketplace_logo>
<disabled>yes|no</disabled>
</marketplace>
...
</marketplaces>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
17 May 2012
Description
Updated XML response
Reason
Align with API
Method Name: /entity/marketplace/margin/list

Method Description
Get the list of margin(s).
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/marketplace/margin/list" api_version="X.Y.Z">
<entity_marketplace_margins>
<entity_marketplace_margin>
<margin></margin>
<organization>The name of the entity</organization>
</entity_marketplace_margin>
...
</entity_marketplace_margins>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/marketplace/margin/set

Method Description
Set or edit a margin.
Parameters
Authentication
token yes
(received
after /login).
The
numerical ID
integer of the entity token=f5a81cdde43c6334feffcfc13ad53717
entity_id yes
for which the
margin is
set/edited
Set the new
value for the
margin (if
string another value margin=200
margin no
exists already,
it will be overwritten)
Return
<liverailapi requested="/entity/marketplace/margin/set" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY VERTICALS
All the methods related to entity verticals are displayed here.

/entity/vertical/add
/entity/vertical/edit
/entity/vertical/list
/entity/vertical/delete
/entity/vertical/resolve/name
/entity/vertical/publisher/list
/entity/vertical/available
Method Name: /entity/vertical/list

Method Description
This method is available only to network entities: list all the verticals for their
publishers.
Parameters
Name

Authentication
token
yes
(received
after /login).
Search based
on the string
contained by
string the vertical search_string=temp
search_string no
name. This
parameter is
optional.
Search based
on the
complete
string vertical name. vertical_name=temporar_vertical
vertical_name no
This
parameter is
optional.
Optional, the
numeric ID of
the vertical for
which the
information
will be
returned. If
you have
multiple id(s)
you can make
a single call
by glueing
integer them together vertical_id=68574
vertical_id
no
with | or , (
examples: if
you need to
get the
information
for vertical
id(s) 1, 7 and
120 you can
use
vertical_id =
1|7|120 or
vertical_id =
1,7,120 ).
Limit the
number of
results for
string pagination(s). limit=10
limit
no
This
parameter is
optional.
The offset
from where
the limit
should be
applied ( if
you display
10 entities per
page and you
need to get
the 3rd page
string you should offset=20
offset
no
set offset to
20 and limit to
10 ). This
parameter is
optional and
shouldn't be
given without
giving the limit
parameter as
well.
Accepted
values: 0 | 1.
If set to 1, will
return only
string the IDs of the return_deleted=1
return_deleted no
deleted
verticals. The
default value
is "0"
Return
<liverailapi requested="/entity/vertical/list" api_version="X.Y.Z">
<verticals>
<vertical>
<vertical_id>The numeric ID of the vertical_name</vertical_id>
<entity_id>The numeric ID of the entity to which the vertical is linked</entity_id>
<vertical_name>The sanitized vertical name. If the name contains non-letter / non-numeric characters, they will be replaced with "_"</vertical_name>
</vertical>
...
</verticals>
<count>The number of verticals</count>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/vertical/publisher/list

Method Description
This method is available only to network entities: list all the verticals for their
publishers.
Parameters
Name
token
publisher_id
vertical_id
start_with
search_string
vertical_name
limit
offset

Authentication
yes
(received
after /login).
The numeric
ID of the
publisher.
integer Separate
no
publisher_id=75
multiple
values with
comma (,).
The numeric
ID of the
vertical.
integer Separate
no
vertical_id=77
multiple
values with
comma (,).
Run the
search based
string on the
no
start_with=dom
vertical's first
part of the
name.
Run the
search based
string on any part of search_string=omain
no
the vertical's
name.
Run the
search based
string on the
no
vertical_name=domain
vertical's
name.
Limit the
integer number of
no
limit=50
results for
no
group_by_vertical_name no
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
10 verticals
per page and
you need to
integer get the 3rd offset=5
page you
should set
offset to 20
and limit to 10
). Do not use
without
specifying the
limit
parameter as
well.
Possible
values:
yes|no. If set
to yes, it will
return a
vertical name
only once. If
the value is
set to no, the
set
group_by_vertical_name=no
same vertical
name might
be returned
several times
( equal to the
number of
publishers
that use the
vertical ).
Return
<liverailapi requested="/entity/vertical/publisher/list" api_version="X.Y.Z">
<verticals>
<vertical>
<vertical_id>The numeric ID of the vertical_name</vertical_id>
<entity_id>The numeric ID of the current vertical</entity_id>
<vertical_name>The sanitized vertical name. If the name contains non-letter / non-numeric characters, they will be replaced with "_".</vertical_name>
</vertical>
...
</verticals>
<count>The number of verticals</count>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/vertical/available

Method Description
Verify the number of available verticals remaining for the specified entity.
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/entity/vertical/available" api_version="X.Y.Z">
<available>The available number of verticals remaining for the specified entity.</available>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/vertical/resolve/name

Method Description
Resolve the vertical names for a list of vertical IDs.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
vertical to be
integer resolved.
vertical_id yes
vertical_id=7,88
Multiple IDs
can be used,
separated by
"," or "|".
Return
<liverailapi requested="/entity/vertical/resolve/name" api_version="X.Y.Z">
<verticals>
<vertical>
<vertical_id>The numeric ID of the resolved vertical</vertical_id>
<vertical_name>The sanitized vertical name. If the name contains non-letter / non-numeric characters, they will be replaced with "_"</vertical_name>
</vertical>
...
</verticals>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/vertical/add

Method Description
Add a new vertical to the entity. A vertical market (often referred to simply as a
"vertical") is a group of similar businesses and customers that engage in trade
based on specific and specialized needs. Often, participants in a vertical market
are very limited to a subset of a larger industry (a niche market). An example of
this sort of market is the market for point-of-sale terminals, which are often
designed specifically for similar customers and are not available for purchase to
the general public. Vertical marketing can be witnessed at trade shows. The
opposite of vertical marketing is horizontal marketing.
Parameters
Name

Authentication
token
yes
(received
after /login).
The name of
the new
vertical. If the
name
contains nonstring letter / non- vertical_name=Electronics
vertical_name yes
numeric
characters,
they will be
replaced with
"_"
Return
<liverailapi requested="/entity/vertical/add" api_version="X.Y.Z">
<vertical_id>The numeric ID of the newly created vertical</vertical_id>
<vertical_name>The sanitized vertical name, if it contains non-letter / non-numeric characters.</vertical_name>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/vertical/add

Method Description
Edit an existing vertical. If the vertical name is changed, the vertical_id
numeric value will also be updated.
Please check the new vertical_id allocated by the system to avoid any confusions.
The numeric ID of the vertical_id remains unchanged if the vertical name is not
changed either.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
integer numerical ID vertical_id=25
vertical_id
yes
of the vertical
to be edited.
The new
name of the
new vertical.
If the name
contains nonstring letter / non- vertical_name=Electronics
vertical_name no
numeric
characters,
they will be
replaced with
"_"
Return
<liverailapi requested="/entity/vertical/edit" api_version="X.Y.Z">
<vertical_id>The new numeric ID of the vertical for which the name was edited</vertical_id>
<vertical_name>The sanitized vertical name, if it contains non-letter / non-numeric characters.</vertical_name>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/vertical/delete

Method Description
Delete an existing vertical.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
integer ID of the
vertical_id yes
vertical_id=77
vertical to be
deleted.
Return
<liverailapi requested="/entity/vertical/publisher/list" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY CONTACTS
All the methods related to entity contacts are displayed here.

/entity/contact/add
/entity/contact/edit
/entity/contact/list
/entity/contact/delete
Method Name: /entity/contact/delete

Method Description
List all the available contacts or the information for a given entity. If no entity is
specified, all the contacts of the current entity will be listed.
Parameters
Name

Authentication
session token
string
token
yes
(received
after /login).
Search for the
integer contact
entity_id
no
entity_id=5584
details of a
specific entity
Search for the
integer details of a entity_contact_id=44
entity_contact_id no
specific
contact
Return
<liverailapi requested="/entity/contact/list" api_version="X.Y.Z">
<contacts>
<contact>
<entity_contact_id>The numerical ID of the contact full_name</entity_contact_id>
<entity_id>The numerical ID of the current entity</entity_id>
<type>The type of contact</type>
...
</contact>
</contacts>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/contact/add

Method Description
Add a new contact to the entity. If no entity is specified, the newly created contact
will be directly attached to the current entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The type of
the contact.
The accepted
enum values are type=emergency
type
yes
"business",
"technical",
"emergency".
The name of
string the new
full_name
no
full_name=firstname lastname
contact
The title of
string the new
title
no
title=Mr
contact.
The contact's
email
address. If
you have
multiple email
string addresses, [email protected]
email
no
you can make
a single call
by glueing
them together
with comma
"," or pipe "|"
The contact's
string primary
phone
no
phone=0554858
phone
number.
The contact's
string secondary phone1=0554860
phone1
no
phone
number.
string The Contact city_state=Cluj Romania
city_state
no
City and State
Specify the
email
notification
address. If
you have
multiple email
notify_emails no
you can make
a single call
by glueing
them together
with comma
support_zone no
"," or pipe "|"

string The contact's support_zone=RO
support zone.
Return
<liverailapi requested="/entity/contact/add" api_version="X.Y.Z">
<entity_contact_id>The numeric ID of the newly created contact</entity_contact_id>
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/contact/edit

Method Description
Edit a specific contact for an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
integer numerical ID entity_contact_id=44
entity_contact_id yes
of the contact
to be edited.
The type of
the contact.
The accepted
values are
"business",
enum "technical", type=emergency
type
no
"emergency".
Only one
contact of
each type is
accepted by
the entity.
The name of
string the new
full_name
no
full_name=firstname lastname
contact
The title of
string the new
title
no
title=Mr
contact.
The contact's
email
address. If
you have
multiple email
email
no
you can make
a single call
by glueing
them together
with comma
"," or pipe "|"
The contact's
string primary
phone
no
phone=0554858
phone
number.
phone1
no
string
city_state
no
string
notify_emails
no
string
support_zone
no
string
The contact's
secondary
phone1=0554860
phone
number.
The Contact
city_state=Cluj Romania
City and State
Specify the
email
notification
address. If
you have
multiple email
addresses, [email protected]
you can make
a single call
by glueing
them together
with comma
"," or pipe "|"
The contact's
support_zone=RO
support zone.
Return
<liverailapi requested="/entity/contact/edit" api_version="X.Y.Z">
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/contact/delete

Method Description
Deletes a specific contact from an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
integer ID of the
entity_contact_id yes
entity_contact_id=44
contact to be
deleted.
Return
<liverailapi requested="/entity/contact/delete" api_version="X.Y.Z">
<user>
..
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY TRACKERS
All the methods related to Entity Trackers are displayed here.

/entity/tracker/add
/entity/tracker/edit
/entity/tracker/list
/entity/tracker/delete
Method Name: /entity/tracker/list

Method Description
List the trackers associated with a entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
ID of the
integer entity for
entity_id yes
entity_id=5412
which the
trackers will
be listed.
Return
<liverailapi requested="/entity/tracker/list" api_version="X.Y.Z">
<entity>
<trackers>
<tracker>
<entity_tracker_id>the numeric ID of the tracker</entity_tracker_id>
<event>the event of tracker</event>
<url>the URL of the tracker</url>
</tracker>
...
</trackers>
</entity>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
17 May 2012
Description
Added method into the help file
Reason
Align with API
Method Name: /entity/tracker/add

Method Description
Adds a new tracker for a specified entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
ID of the
integer entity to
entity_id yes
entity_id=5412
which the
tracker will be
added.
The tracker
event:
impression impression,
accept accept
invitation,
clickthru video clickthrough,
view25 - first
quartile (25%
watched),
view50 midpoint
(50%
watched),
view75 - third
quartile (75%
watched),
string view100 event yes
event=close
complete
view (100%
watched),
pause - video
paused, mute
- video muted,
minimize minimize
overlay, close
- close,
companion companion
impression,
error - error,
skip, custom1
url
yes
from custom8
- custom
events that
can be send
from player
string The URL of url=http://www.tracker-url.com/tracker2
the tracker
Return
<liverailapi requested="/entity/tracker/add" api_version="X.Y.Z">
<entity_tracker_id>the numeric ID of the new tracker</entity_tracker_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
17 May 2012
11 July 2012
11 September 2012
Description
Changed event values
Added 'error' in event values
Reason
Align with API
Align with API
Align with API
Method Name: /entity/tracker/edit

Method Description
Edits a tracker for a specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer entity for
entity_id
yes
entity_id=5412
which the
tracker will be
edited.
The numeric
integer ID of the
entity_tracker_id yes
entity_tracker_id=224
tracker which
will be edited.
The new
tracker event:
impression impression,
accept accept
invitation,
clickthru video clickthrough,
view25 - first
quartile (25%
watched),
view50 midpoint
(50%
watched),
view75 - third
quartile (75%
watched),
string view100 event
no
event=close
complete
view (100%
watched),
pause - video
paused, mute
- video muted,
minimize -
url
no
minimize
overlay, close
- close,
companion companion
impression,
error - error,
skip, custom1
from custom8
- custom
events that
can be send
from player
string The new URL url=http://www.tracker-url.com/tracker2
of the tracker
Return
<liverailapi requested="/entity/tracker/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
17 May 2012
11 July 2012
11 September 2012
Description
Reason
Align with API
Align with API
Align with API
Method Name: /entity/tracker/delete

Method Description
Deletes a tracker attached to an entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the entity
integer from which the entity_id=5412
entity_id
yes
tracker will be
deleted.
Optional, the
numeric ID of
the tracker to be
deleted. If no
integer entity_tracker_id entity_tracker_id=224
entity_tracker_id no
is specified, all
the trackers
attached to
entity_id will be
deleted.
Return
<liverailapi requested="/entity/tracker/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
17 May 2012
Description
Reason
Align with API
ENTITY DOMAIN CONTROL
All the methods related to entity domain control are displayed here.
/entity/domain/control/add
/entity/domain/control/list
/entity/domain/control/delete
Method Name: /entity/domain/control/list

Method Description
List all the available controlled domains or the information for a given entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric
ID of the entity
for which the
information
will be
returned. If
integer you have
entity_id
no
entity_id = 1|7|120 or entity_id = 1,7,120
multiple id(s)
you can make
a single call
by glueing
them together
with | or ,
The name of
the domain to
be returned.
The search
string will be
domain_name no
domain_name=test
performed
only in the
current or
specified
entity_id.
The search
string for the
domain_name.
The search
string will be
domain_search no
domain_search=te
performed
only in the
current or
specified
entity_id.
Limit the
number of
int
limit
no
limit=50
results for
pagination(s).
The offset
from where
the limit
should be
offset
no
int
applied ( if
you display 10
domains per
page and you
need to get
offset=5
the 3rd page
you should set
offset to 20
and limit to 10
). Do not use
without
specifying the
limit parameter
as well.
Return
<liverailapi requested="/entity/domain/control/list" api_version="X.Y.Z">
<domains>
<domain>
<domain_name>The name of the controlled domain</domain_name>
</domain>
...
</domains>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/control/add

Method Description
Add a new controlled domain for a specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The name of
string the new
domain_name yes
domain=test.com
controlled
domain.
Return
<liverailapi requested="/entity/domain/control/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/domain/control/delete

Method Description
Deletes an existing controlled domain from an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The name of
string the domain to domain_name=test
domain_name yes
be deleted.
Return
<liverailapi requested="/entity/domain/control/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ENTITY AUDIENCE
All the methods related to entity audience are displayed here.

/entity/audience/provider/list
/entity/audience/segment/list
Method Name: /entity/audience/provider/list

Method Description
List all the audience providers for a specific entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
ID of the
entity for
which the
audience
providers will
integer be listed. If no entity_id=788
entity_id no
value is
specified, the
search will be
performed on
the current
entity.
Return
<liverailapi requested="/entity/audience/provider/list" api_version="x.y.z">
<providers>
<provider>
</provider>
...
</providers>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/audience/segment/list

Method Description
List all the audience segments for a specific entity.
Parameters
Authentication
token yes
(received
after /login).
The numeric
ID of the
entity for
which the
sudence
segments will
integer be listed. If no entity_id=788
entity_id no
value is
specified, the
search will be
performed on
the current
entity.
Return
<liverailapi requested="/entity/audience/segment/list" api_version="x.y.z">
<count>The number of segments.</count>
<segments>
<segment>
</segment>
...
</segments>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
AUDIENCE
All the methods related to audience are displayed here.

/audience/provider/resolve/name
/audience/segment/resolve/name
Method Name: /audience/provider/resolve/name

Method Description
Resolve the name of one or more audience providers.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
audience
provider to be
integer resolved.
audience_id yes
audience_id=7,88
Multiple IDs
can be used,
separated by
"," or "|".
Return
<liverailapi requested="/audience/provider/resolve/name" api_version="x.y.z">
<providers>
<provider>
<audience_id>The numerical ID of the audience.</audience_id>
<audience_name>The name of the audience</audience_name>
</provider>
...
</providers>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /audience/segment/resolve/name

Method Description
Resolve the name of one or more audience segments.
Parameters
Name

Authentication
session token
string
token
yes
(received
after /login).
The numeric
ID of the
audience
segment to be
integer resolved.
audience_segment_id yes
audience_segment_id=7,88
Multiple IDs
can be used,
separated by
"," or "|".
Return
<liverailapi requested="/audience/segment/resolve/name" api_version="x.y.z">
<segments>
<segment>
<audience_segment_id>The numerical ID of the audience segment.</audience_segment_id>
<audience_segment_name>The name of the audience segment.</audience_segment_name>
<audience_name>The name of the audience.</audience_name>
</segment>
...
</segments>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
CATEGORIES
All the methods related to categories are displayed here.

/categories/list
/categories/resolve/name
Method Name: /category/list

Method Description
List all the available categories.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
category for
which the
information
will be
string returned. If category_id = 1|7|120 or category_id =
category_id
no
you have
1,7,120
multiple ID(s)
you can make
a single call
by glueing
them together
with | or ,
The numeric
ID of the
parent
category for
which the
children
categories will
string be returned. If parent_category_id = 1|7|120 or
parent_category_id no
parent_category_id = 1,7,120
you have
multiple ID(s)
you can make
a single call
by glueing
them together
with | or ,
Returns only
string the category search_string=music
search_string
no
that has this
name.
Limit the
int number of
limit
no
limit=50
results for
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
10 entities per
page and you
need to get
int the 3rd page offset=5
offset
no
you should
set offset to
source
no
return_deleted
no
20 and limit to
10 ). Do not
use without
specifying the
limit
parameter as
well.
Specify the
category
source
string (LiveRail or source=yt
Youtube). The
accepted
values are:
"lr" and "yt".
Returns only
string the deleted return_deleted=yes
categories.
Return
<liverailapi requested="/category/list" api_version="X.Y.Z">
<categories>
<category>
<category_id>The numeric ID of the category</category_id>
<parent_category_id>The numeric ID of the parent category</parent_category_id>
<category_name>The name of the category_id</category_name>
<source>lr / yt</source>
</category>
...
<categories>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /category/resolve/name

Method Description
Resolve the category names for a list of category IDs.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
category to
integer be resolved. category_id = 1|7|120 or category_id =
category_id yes
Multiple IDs 1,7,120
can be used,
separated by
"," or "|".
Return
<liverailapi requested="/category/resolve/name" api_version="X.Y.Z">
<categories>
<category>
<category_id>The numeric ID of the resolved category</category_id>
<category_name>The category name.</category_name>
<source>The source of the category</source>
</category>
...
</categories>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
SUB SITES
All the methods related to entity sub sites are displayed here.
/entity/sub/site/list
/entity/sub/site/set
Method Name: /entity/sub/site/list

Method Description
Displays the information related to entity sub-site(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
integer of the
network_id no
network_id=8976
network to be
listed.
The
integer numerical ID sub_site_id=5487
sub_site_id no
of the subsite
to be listed.
Return
<liverailapi requested="/entity/sub/site/list" api_version="X.Y.Z">
<sub_sites>
<sub_site>
<network_id>the id of the entity acting as a network ( the current entity )</network_id>
<sub_site_id>the id of the entity acting as a sub site</sub_site_id>
<organization>the name of the sub site</organization>
<connections>
<connection>
<connection_id>The numerical ID of the connection</connection_id>
<enabled_network>values: 1/0</enabled_network>
<enabled_publisher>values: 1/0</enabled_publisher>
<enabled_ov>values: 1/0</enabled_ov>
<enabled_in>values: 1/0</enabled_in>
<cost_model>values: cpm/cpc</cost_model>
</connection>
</connections>
</sub_site>
...
</sub_sites>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /entity/sub/site/set

Method Description
Set a given entity as a subsite.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
integer of the
network_id yes
network_id=8976
network to be
set as
subsite.
The
integer
sub_site_id yes
numerical ID sub_site_id=398756
of the subsite.
Return
<liverailapi requested="/entity/sub/site/list" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
NETWORK LABEL
All the methods related to the network labels are displayed here.
/network/label/add
/network/label/edit
/network/label/list
/network/label/delete
/network/site/label/list
/network/site/label/set
Method Name: /network/label/list

Method Description
Lists the network label(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
Return only
the labels
with the
specified
integer
label_id
no
numerical ID. label_id=556
Multiple IDs
can be bind
together by "|"
or ","
Return only
the labels that
string have a title search_string=music
search_string no
matching the
given search
string.
Return
<liverailapi requested="/network/label/list" api_version="X.Y.Z">
<labels>
<label>
<label>The name of the label</label>
<label_id>The numerical ID of the label</label_id>
<network_id>The numerical ID of the network</network_id>
</label>
...
</labels>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /network/label/add

Method Description
Add a label to the network.
Parameters
Example
Authentication
token yes
(received after
/login).
string The name of the label=testnetwork
label yes
new label.
Return
<liverailapi requested="/network/label/add" api_version="X.Y.Z">
<label_id>The numerical ID of the newly created label</label_id>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /network/label/edit

Method Description
Edits an existing label.
Parameters
Authentication
token yes
(received
after /login).
The
integer numerical ID label_id=5556
label_id yes
of the label to
be edited.
The new
string name of the label=testnetworknew
label yes
label.
Return
<liverailapi requested="/network/label/edit" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /network/label/delete

Method Description
Deletes an existing label.
Parameters
Authentication
token yes
(received
after /login).
The
numerical ID
of the label to
be deleted. If
the label to be
integer deleted is set label_id=556
label_id yes
with
publishers, all
associations
will be
deleted.
Return
<liverailapi requested="/network/label/delete" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /network/site/label/list

Method Description
Lists the network label(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
Return only
the labels
with the
specified
integer numerical ID. label_id=556
label_id
no
Multiple IDs
can be bind
together by "|"
or ","
Return only
labels
attached to
the publisher
with the
integer specified
publisher_id no
publisher_id=5241, 7856
numerical ID.
Multiple IDs
can be bind
together by "|"
or ","
Return
<liverailapi requested="/network/site/label/list" api_version="X.Y.Z">
<labels>
<label>
<publisher_id>The numerical ID of the publisher.</publisher_id>
<publisher_name>The name of the publisher</publisher_name>
<label_id>The numercial ID of the label</label_id>
<label>The name of the label</label>
<enabled_in>1</enabled_in>
<enabled_ov>1</enabled_ov>
</label>
...
</labels>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /network/site/label/set

Method Description
Set label(s) to a site (publisher).
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical
ID of the
integer publisher to
publisher_id yes
publisher_id=5241, 7856
which the label
will be attached.
The numerical
ID of the label(s)
to be attached
to the publisher.
If the value is
integer specified as
label_id
yes
label_id=556
"LR_API_NULL",
all the labels
attached to a
site will be
cleared.
Return
<liverailapi requested="/network/site/label/set" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
SUMMARY
All the methods related to summaries are displayed here.

/summary/domain/list
/summary/fingerprint/list
/summary/tag/list
/summary/media/list
/summary/partner/list
/summary/vertical/list
/summary/order/list
/summary/order/line/list
/summary/creative/list
/summary/creative/campaign/list
Method Name: /summary/domain/list

Method Description
List the domain(s) summary for the current or specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
string which the
entity_id
no
entity_id=6084
information
will be
returned.
The search
string for the
domain name.
The search
int will be
search_domain no
search_domain=blogspot
performed
only in the
current or
specified
entity_id.
Limit the
int number of
limit
no
limit=10
results for
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
10 domains
per page and
you need to
get the 3rd
int page you
offset
no
offset=20
should set
offset to 20
and limit to 10
). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/domain/list" api_version="x.y.z">
<domains>
<list>
<domain>
<domain>The domain name</domain>
</domain>
...
</list>
</domains>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
07 June 2012
Description
Added method in documentation.
Reason
Align with API tester
Method Name: /summary/fingerprint/list

Method Description
List the fingerprint(s) summary for the current or specified entity(es).
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the entity for
which the
information will
be returned. If
you have
multiple id(s)
you can make a
single call by
glueing them
together with |
or , ( examples:
string if you need to entity_id=6084, 8876
entity_id
no
get the entities
for id(s) 1, 7 and
120 you can use
entity_id =
1|7|120 or
entity_id =
1,7,120 ). By
default the
method will
return the
fingerprints for
the current
entity.
The search
string for the
fingerprint
name. The
int
search_fingerprint no
search will be search_fingerprint=intro
performed only
in the current or
specified
entity_id.
If you have
multiple
fingerprints, you
can make a
single call by
fingerprint
no
limit
no
offset
no
group_by
no
group_by_name no
glueing them
string together with | fingerprint=fin_intro, fin_dual
or , By default
the method will
return the
fingerprints for
the current
entity.
Limit the number
int of results for
limit=10
pagination(s).
The offset from
where the limit
should be
applied ( if you
display 10
fingerprints per
page and you
need to get the
int 3rd page you offset=20
should set offset
to 20 and limit to
10 ). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Group by. If the
value is
string "LR_API_NULL", group_by=LR_API_NULL
the grouping will
be cleared.
Specify if the
grouping will be
done by name.
enum The possible group_by_name=yes
values are "yes"
| "no". Default
value is "no".
Return
<liverailapi requested="/summary/fingerprint/list" api_version="x.y.z">
<fingerprints>
<list>
<fingerprint>
<fingerprint>The fingerprint name</fingerprint>
</fingerprint>
...
</list>
</fingerprints>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
07 June 2012
Description
Reason
Method Name: /summary/tag/list

Method Description
List the tag(s) summary for the current or specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
string which the
entity_id no
entity_id=6084
information
will be
returned.
The search
string for the
tag. It must
contain at
least 3 letters.
The search
will be
performed
only in the
current or
int specified
search_tag no
search_tag=intro
entity_id. The
result will
return only
the tags with
the name
matching the
search string.
This
parameter is
optional.
Limit the
int number of
limit
no
limit=10
results for
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
offset
no
int
10 tags per
page and you
need to get
the 3rd page
offset=20
you should
set offset to
20 and limit to
10 ). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/tag/list" api_version="x.y.z">
<tags>
<list>
<tag>
<tag>The tag name</tag>
</tag>
...
</list>
</tags>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
07 June 2012
Description
Reason
Method Name: /summary/media/list

Method Description
List the media(s) summary for the current or specified entity(es).
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the entity for
which the
information will
be returned. If
you have
multiple id(s)
you can make a
single call by
glueing them
together with |
or , ( examples:
string if you need to entity_id=6084, 8876
entity_id
no
get the media
for id(s) 1, 7 and
120 you can use
entity_id =
1|7|120 or
entity_id =
1,7,120 ). By
default the
method will
return the
medias for the
current entity.
The search
string for the
media name.
The search will
int be performed search_media=intro
search_media no
only in the
current or
specified
entity_id.
If you have
multiple medias,
you can make a
single call by
glueing them
string
media
no
limit
no
offset
no
group_by
no
group_by_name no
string together with | media=med_intro, med_dual

or , By default
the method will
return the
medias for the
current entity.
Limit the number
int of results for
limit=10
pagination(s).
The offset from
where the limit
should be
applied ( if you
display 10
medias per page
and you need to
get the 3rd page
int you should set offset=20
offset to 20 and
limit to 10 ). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Group by. If the
value is
string "LR_API_NULL", group_by=LR_API_NULL
the grouping will
be cleared.
Specify if the
grouping will be
done by name.
enum The possible group_by_name=yes
values are "yes"
| "no". Default
value is "no".
Return
<liverailapi requested="/summary/media/list" api_version="x.y.z">
<medias>
<list>
<media>
<media>The media name</media>
</media>
...
</list>
</medias>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
07 June 2012
Description
Reason
Method Name: /summary/partner/list

Method Description
List the partner(s) summary for the current or specified entity(es).
Parameters
Name
token
entity_id

Authentication
yes
(received
after /login).
The numeric
ID of the
entity(es) for
which the
information
will be
returned. If
you have
multiple id(s)
you can make
a single call
by glueing
them together
with | or , (
examples: if
string you need to entity_id=6084, 8876
no
get the
partners for
id(s) 1, 7 and
120 you can
use entity_id
= 1|7|120 or
entity_id =
1,7,120 ). The
parameter is
optional and
by default the
method will
return the
partners for
the current
entity.
The numeric
ID of the
partner(es)
for which the
information
will be
returned. If
partner_id
no
search_partner no
limit
no
offset
no
returned. If
you have
multiple id(s)
you can make
a single call
string by glueing
partner_id=25, 476
them together
with | or , (
examples: if
you need to
get the info
for id(s) 1, 7
and 120 you
can use
partner_id =
1|7|120 or
partner_id =
1,7,120 ).
The search
string for the
partner name.
The search
int will be
search_partner=intro
performed
only in the
current or
specified
entity_id.
Limit the
int number of
limit=10
results for
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
10 partners
per page and
you need to
get the 3rd
int page you
offset=20
should set
offset to 20
and limit to 10
). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/partner/list" api_version="x.y.z">
<partners>
<list>
<partner>
<partner_id>The numeric ID of the partner</partner_id>
<partner>The partner name</partner>
</partner>
...
</list>
<count>The number of returned results</count>
</partners>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
07 June 2012
Description
Reason
Method Name: /summary/vertical/list

Method Description
List the vertical(s) summary for the current or specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
string which the
entity_id
no
entity_id=6084
information
will be
returned.
The search
string for the
vertical name.
The search
will be
performed
only in the
current or
specified
entity_id. If
you have
multiple id(s)
you can make
int a single call search_vertical=intro
search_vertical no
by gluing
them together
with | or , (
examples: if
you need to
get the info
for id(s) 1, 7
and 120 you
can use
vertical_id =
1|7|120 or
vertical_id =
1,7,120 )
Limit the
int number of
limit
no
limit=10
results for
pagination(s).
offset
no
int
The offset
from where
the limit
should be
applied ( if
you display
10 verticals
per page and
you need to
get the 3rd
page you
offset=20
should set
offset to 20
and limit to 10
). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/vertical/list" api_version="x.y.z">
<verticals>
<list>
<vertical>
<vertical_name>The vertical name</vertical_name>
</vertical>
...
</list>
<count>Number of returned verticals</count>
</verticals>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
22 January 2013
Description
Reason
Method Name: /summary/order/list

Method Description
List the order(s) summary for the current or specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
string which the
entity_id
no
entity_id=6084
information
will be
returned.
The search
string for the
order name.
The search
will be
performed
only in the
current or
specified
entity_id. If
you have
multiple id(s)
you can make
int a single call search_order=intro
search_order no
by gluing
them together
with | or , (
examples: if
you need to
get the info
for id(s) 1, 7
and 120 you
can use
order_id =
1|7|120 or
order_id =
1,7,120 )
Limit the
int number of
limit
no
limit=10
results for
pagination(s).
offset
no
int
The offset
from where
the limit
should be
applied ( if
you display
10 orders per
page and you
need to get
the 3rd page
offset=20
you should
set offset to
20 and limit to
10 ). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/order/list" api_version="x.y.z">
<order_lies>
<order_line>
<order_line_id>The order line ID</order_line_id>
<order_id>The Order ID</order_id>
<publisher_id>The publisher ID</publisher_id>
<network_id>The Network ID</network_id>
<position>the position</position>
<cost_advertiser>cost for advertiser</cost_advertiser>
<cost_publisher>cost for publisher</cost_publisher>
<cost_publisher_bid>cost for publisher bid</cost_publisher_bid>
<impression>The number of impressions</impression>
<clickthru>The number of clickthroughs</clickthru>
<view100>Number of view100</view100>
<accept>Accept value</accept>
<cost_fees>cost fees</cost_fees>
</order_line>
...
</order_lines>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
22 January 2013
Description
Reason
Method Name: /summary/order/line/list

Method Description
List the order line(s) summary for the current or specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
string which the
entity_id
no
entity_id=6084
information
will be
returned.
The search
string for the
order name.
The search
will be
performed
only in the
current or
specified
entity_id. If
you have
multiple id(s)
you can make
int a single call search_order=intro
search_order no
by gluing
them together
with | or , (
examples: if
you need to
get the info
for id(s) 1, 7
and 120 you
can use
order_id =
1|7|120 or
order_id =
1,7,120 )
Limit the
int number of
limit
no
limit=10
results for
pagination(s).
The offset
offset
no
int
from where
the limit
should be
applied ( if
you display
10 orders per
page and you
need to get
the 3rd page
offset=20
you should
set offset to
20 and limit to
10 ). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/order/line/list" api_version="x.y.z">
<order_lies>
<order_line>
<order_id>The Order ID</order_id>
<network_id>The Network ID</network_id>
<position>the position</position>
<cost_advertiser>cost for advertiser</cost_advertiser>
<cost_publisher>cost for publisher</cost_publisher>
<cost_publisher_bid>cost for publisher bid</cost_publisher_bid>
<impression>The number of impressions</impression>
<clickthru>The number of clickthroughs</clickthru>
<view100>Number of view100</view100>
<accept>Accept value</accept>
<cost_fees>cost fees</cost_fees>
</order_line>
...
</order_lines>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
22 January 2013
Description
Reason
Method Name: /summary/creative/list

Method Description
List the creative(s) summary for the current or specified entity.
Parameters
Name

Example
Authentication
token
yes
The numeric ID of the
string entity for which the entity_id=6084
entity_id
no
information will be
returned.
creative(s) for which
the information will be
returned. If you have
multiple id(s) you can
make a single call by
string gluing them together creative_id=1,7,120 or creative_id=1|7|120
creative_id
no
with | or , ( examples:
if you need to get the
info for id(s) 1, 7 and
120 you can use
creative_id = 1|7|120
or creative_id =
1,7,120 )
The numerical ID of
the creative
campaign(s) for
which the info will be
string gluing them together creative_campaign_id=1,7,120 or
creative_campaign_id no
with | or , ( examples: creative_campaign_id=1|7|120
if you need to get the
info for id(s) 1, 7 and
120 you can use
creative_campaign_id
= 1|7|120 or
= 1,7,120 )
The search string for
the creative name.
int The search will be search_creative=intro
search_creative
no
performed only in the
current or specified
entity_id.
Limit the number of
int results for
limit
no
limit=10
pagination(s).
The offset from
where the limit should
offset
no
int
be applied ( if you
display 10 creatives
per page and you
need to get the 3rd
page you should set offset=20
offset to 20 and limit
to 10 ). This
parameter shouldn't
be given without
giving the limit
parameter as well.
Return
<liverailapi requested="/summary/creative/list" api_version="x.y.z">
<creatives>
<list>
<creative>
<creative_id>The creative ID</creative_id>
<impression>Number of impressions</impression>
<clickthru>Number of clickthroughs</clickthru>
<title>The title</title>
</creative>
...
</list>
<count>Number of returned creatives</count>
</creatives>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
22 January 2013
Description
Reason
Method Name: /summary/creative/campaign/list

Method Description
List the creative campaign(s) summary for the current or specified entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
entity for
string which the
entity_id
no
entity_id=6084
information
will be
returned.
The numeric
ID of the
creative
string campaign for entity_id=6084
no
which the
information
will be
returned.
The search
string for the
creative
name. The
search will be
int performed
search_creative_campaign no
search_creative=intro
only in the
current or
specified
entity_id. This
parameter is
optional.
Limit the
int number of
limit
no
limit=10
results for
pagination(s).
The offset
from where
the limit
should be
applied ( if
you display
10 creatives
per page and
you need to
get the 3rd
int page you
offset
no
offset=20
should set
offset to 20
and limit to 10
). This
parameter
shouldn't be
given without
giving the limit
parameter as
well.
Return
<liverailapi requested="/summary/creative/campaign/list" api_version="x.y.z">
<creative_campaigns>
<list>
<creative_campaign>
<creative_campaign_id>The creative campaign ID</creative_campaign_id>
<impression>Number of impressions</impression>
<clickthru>Number of clickthroughs</clickthru>
<creative_campaign_name>The campaign name</creative_campaign_name>
</creative_campaign>
...
</list>
<count>Number of returned creative campaigns</count>
</creative_campaigns>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
22 January 2013
Description
Reason
CREATIVES
A creative can only exist within a single creative campaign group. A creative contains several
elements:
A name;
A defined type from the following list:
Linear In-stream (Pre/Mid/Post-Roll)
Overlay with Takeover
Overlay without Takeover
Text Overlay
Linear VPAID
Non-linear VPAID
An uploaded asset, such as an FLV, which will be transcoded automatically by LiveRail into
multiple formats and bit rates; a URL can be provided if the asset is hosted on another server;
A click-thru URL;
A VAST tag trafficked from another ad server can be inputted instead of an asset and a click-thru
URL;
Optional companion banner(s) containing a creative asset and clickthru; if a VAST tag is being
trafficked, then this optional is controlled within the VAST tag and not available for modification;
3rd party trackers, meant for integrating trackers or pixels from tools such as a 3rd party ad server
such as an Atlas or DFA. Thus, creatives are always attached to a creative campaign group;
therefore, ensure that a creative campaign group exists before creating a creative.
Creatives
These are the methods used to handle Creatives:
/creative/add
/creative/duplicate
/creative/edit
/creative/list
/creative/list/owned/orders
/creative/delete
/creative/resolve/name
/creative/set/archived
Video creatives
/creative/video/add
/creative/video/edit
/creative/video/list
/creative/video/upload
/creative/video/delete
Overlay creatives
/creative/overlay/add
/creative/overlay/edit
/creative/overlay/list
/creative/overlay/upload
/creative/overlay/delete
Companions
/creative/companion/add
/creative/companion/edit
/creative/companion/list
/creative/companion/upload
/creative/companion/delete
Trackers
/creative/tracker/add
/creative/tracker/edit
/creative/tracker/list
/creative/tracker/delete
Creative Advertisers
/creative/advertiser/add
/creative/advertiser/list
/creative/advertiser/delete
Method Name: /creative/list

Method Description
Displays the information related to a creative. Also, it can be used to list the
creatives attached to a creative group (campaign).
Parameters
Name

Example
token
yes
/login).
creative for which the
information will be
returned. The numeric
ID of the creative for
which the information
will be returned. If you
have multiple id(s) you
integer can make a single call creative_id=999, 784
creative_id
no
by glueing them
This parameter is
required if no
creative_campaign_id,
entity_id or
order_line_id is
specified.
creative group
(campaign) for which
the list of the
creatives will be
integer make a single call by creative_campaign_id=543, 548
glueing them together
with | or , This
parameter is required
if no creative_id,
entity_id or
order_line_id is
specified.
entity for which the
information will be
integer glueing them together creative_id=999, 784
entity_id
no
with | or , This
if no
creative_id or
order_line_id is
specified.
Return only the
creatives that are
assigned to this order
line. If you have
string glueing them together order_line_id=o8877666, o630087
order_line_id
no
with | or , This
if no
ad_unit_type
no
status
no
search_string
no
creative_id or
entity_id is specified.
Return only the
creatives of this ad
unit type. The
accepted ad unit
types are: in, ov-take,
string ov-bug, ov-text, vpaid- ad_unit_type=in, ov-take
in, vpaid-ov. If you
have multiple types
you can make a single
Search based on the
status of the creative.
Possible values are:
active, archived,
enum pending, encoding. If status=pending
you have multiple
types you can make a
single call by glueing
them together with | or
,
Return only the
string creatives that have a search_string=music
title matching the
given search string.
Return
<liverailapi requested="/creative/list" api_version="x.y.z">
<creatives>
<creative>
<creative_id>creative's ID</creative_id>
<creative_campaign_id>creative group's (campaign) ID</creative_campaign_id>
<ad_unit_type>ad unit type of the creative</ad_unit_type>
<creation_time>creative creation full date (YYYY-MM-DD HH:MM:SS)</creation_time>
<title>creative title</title>
<description>creative description</description>
<url_text>creative URL link</url_text>
<clickthru>creative's clickthrough URL, defaults to null on creative creation</clickthru>
<adtag>the adtag</adtag>
<status>active, archive, pending, encoding</status>
<timestamp>internal use</timestamp>
<destination_url>The creative's destination url</destination_url>
<advertiser_id>the advertiser ID</advertiser_id>
<skip_offset>Skip Offset value</skip_offset>
<skip_offset_type>seconds/percentage</skip_offset_type>
<security_code>internal use</security_code>
<preview_security_code>internal use</preview_security_code>
</creative>
...
</creatives>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 June 2012
Description
Added more status values, updated several
paramethers.
05 July 2012
Added destination_url.
11 September
2012
Added more parameters.
15 January 2013 Added more XML values
Reason
Align with
API.
Align with
API.
Align with
API.
Align with
API.
Method Name: /creative/resolve/name

Method Description
Simple method that returns the title of a given creative ID or a given list of creative
IDs, separated by comma (,).
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer creative for creative_id=11
creative_id yes
which the title
will be
returned.
Return
<liverailapi requested="/creative/resolve/name" api_version="X.Y.Z">
<creatives>
<creative>
<creative_id>The numeric ID of the creative</creative_id>
<title>The title</title>
</creative>
...
</creatives>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/add

Method Description
Add a new creative to an existing creative group (campaign).
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the creative
group
integer (campaign) to creative_campaign_id=999
creative_campaign_id yes
which the newly
created creative
will be
attached.
The type of the
creative; in instream, ovbug - overlay
without takeover, ov-take string overlay with
ad_unit_type
yes
ad_unit_type=in
take-over, ovtext - text
overlay, vpaidin - VPAID liniar,
vpaid-ov VPAID nonlinear.
The title of the
string newly created title=New
title
yes
creative.
The description
string of the newly
description
yes
description=cartoon
created
creative.
string The URL text url_text=http://www.test.com
url_text
yes
for the creative.
The clickstring through URL for clickthru=www.test.com
clickthru
no
the creative.
Optional, the
status of the
creative.
Possible values
are: "active" (for
active
creatives),
"archived" (for
status
no
timestamp
no
adtag
no
destination_url
no
skip_offset
no
skip_offset_type
no
archived
creatives),
"pending" (for
enum incomplete
status=pending
creative) or
"encoding" (for
creatives for
which you will
upload an asset
through the
creative's
upload method.
The default
value is
"active".
Optional, the
integer timestamp of timestamp=25
the creative.
Optional, the
creative AD tag
string for creatives adtag=??
trafficked
elsewhere.
The destination
URL for the
creative. If
string "LR_API_NULL" destination_url=www.test.com
is used, the
parameter will
be cleared.
Optional, the
skip offset
value for the
creative. The
integer default value is skip_offset=22
"null". If
"LR_API_NULL"
is used, the
parameter will
be cleared.
Optional, the
skip offset type
for the creative.
Possible values
enum are: "seconds", skip_offset_type=percentage
"percentage".
The default
value is
"seconds".
Return
<liverailapi requested="/creative/add" api_version="X.Y.Z">
<security_code>internal use only</security_code>
<creative_id>the numeric ID of the newly created creative.</creative_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 June 2012
Description
paramethers.
05 July 2012
05 December
2012
Added skip_offset, skip_offset_type
Reason
Align with
API.
Align with
API.
Align with
API.
Method Name: /creative/edit

Method Description
Edit an existing creative
Parameters
Name
token
creative_id
ad_unit_type
title

Example
Authentication
yes
(received after
/login).
The numeric ID
integer of the creative creative_id=999
yes
to be edited.
The new type
of the specified
creative; in instream, ovbug - overlay
without takeover, ov-take overlay with
take-over, ovtext - text
overlay, vpaidenum in - VPAID liniar, ad_unit_type=ov-take
no
vpaid-ov VPAID nonlinear. This
parameter is
optional,
meaning that, if
not given, the
parameter
value is not
altered in any
way.
The new title of
the specified
creative. This
parameter is
optional,
string meaning that, if title=edited
no
not given, the
parameter
value is not
altered in any
way.
The new
description of
description
no
string
url_text
no
string
clickthru
no
string
status
no
enum
the specified
creative. This
parameter is
optional,
description=music
meaning that, if
not given, the
parameter
value is not
altered in any
way.
The new URL
text for the
specified
creative. This
parameter is
optional,
url_text=http://www.test.com
meaning that, if
not given, the
parameter
value is not
altered in any
way.
The new clickthrough URL for
the specified
creative. This
parameter is
optional,
meaning that, if
not given, the
parameter
clickthru=www.test.com
value is not
altered in any
way. If
"LR_API_NULL"
is used, the
clickthru
parameter will
be cleared.
The new status
of the specified
creative.
Possible values
are: "active" (for
active
creatives),
"pending" (for
incomplete
creative) or
"encoding" (for
creatives for
which you will status=pending
upload an asset
through the
creative's
upload method.
This parameter
is optional,
meaning that, if
timestamp
no
adtag
no
destination_url no
skip_offset
no
meaning that, if
not given, the
parameter
value is not
altered in any
way.
The new
timestamp of
the creative.
This parameter
is optional,
integer meaning that, if timestamp=25
not given, the
parameter
value is not
altered in any
way.
The new
creative AD tag
for creatives
trafficked
elsewhere. This
parameter is
string optional,
adtag=??
meaning that, if
not given, the
parameter
value is not
altered in any
way.
The destination
URL for the
creative. This
parameter is
optional,
meaning that, if
not given, the
string parameter
destination_url=www.test.com
value is not
altered in any
way. If
"LR_API_NULL"
is used, the
parameter will
be cleared.
The skip offset
value for the
creative. This
parameter is
optional,
meaning that, if
not given, the
integer parameter
skip_offset=22
value is not
altered in any
way. If
"LR_API_NULL"
is used, the
parameter will
skip_offset_type no
be cleared.
The skip offset
type for the
creative.
Possible values
are: "seconds",
"percentage".
enum This parameter skip_offset_type=percentage
is optional,
meaning that, if
not given, the
parameter
value is not
altered in any
way.
Return
<liverailapi requested="/creative/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 June 2012
Description
paramethers.
05 July 2012
05 December
2012
Added skip_offset, skip_offset_type
Reason
Align with
API.
Align with
API.
Align with
API.
Method Name: /creative/delete

Method Description
Delete one ore more existing creatives.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID(s) of the
creative(s) to
be deleted. If
you have
multiple id(s)
you can make
a single call
by glueing
them together
integer with | or , ( creative_id=999, 66534
creative_id yes
examples: if
you need to
delete the
creatives with
the id(s) 1, 7
and 120 you
can use
creative_id =
1|7|120 or
creative_id =
1,7,120 ).
Return
<liverailapi requested="/creative/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/duplicate

Method Description
Duplicate an existing creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
integer ID of the
creative_id yes
creative_id=999
creative to be
duplicated.
Accepted
values are:
"true" "false".
Default value
bool is "false". If trackers=1
trackers no
specified as
"true", the
trackers will
be duplicated.
Accepted
values are:
"true" "false".
Default value
bool is "false". If media=1
media
no
specified as
"true", the
media will be
duplicated.
Accepted
values are:
"true" "false".
Default value
bool is "false". If companion=1
companion no
specified as
"true", the
companions
will be
duplicated.
Return
<liverailapi requested="/creative/duplicate" api_version="X.Y.Z">
<creative_id>The duplicate creative's ID</creative_id>
<user> ... </user>

<auth> ... </auth>
...
</liverailapi>
Change History
Date
14 May
2012
Description
Added trackers, media, companions with new
rules
Reason
Align with API
tester
Method Name: /creative/set/archived

Method Description
Set a creative to archived.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
integer ID of the
creative_id yes
creative_id=52145
creative to be
archived.
Set the
creative to be
archived. The
accepted
enum values are is_archived=yes
is_archived yes
"yes" or "no".
Cannot be
used for
inactive
creatives.
Return
<liverailapi requested="/creative/set/archived" api_version="x.y.z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 January 2013
Description
Added page into CHM
Reason
Align with API
VIDEO CREATIVES
All the methods related to video creatives are displayed here.

/creative/video/add
/creative/video/edit
/creative/video/list
/creative/video/upload
/creative/video/delete
Method Name: /creative/video/list

Method Description
List the video asset(s) attached to a creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
existing ininteger stream
creative_id yes
creative_id=222
creative for
which the
video data is
retrieved.
Return
<liverailapi requested="/creative/video/list" api_version="X.Y.Z">
<creative>
<videos>
<video>
<type>type of the video asset</type>
<bitrate>bitrate of the video asset</bitrate>
<width>width of the video asset</width>
<height>height of the video asset</height>
<duration>duration of the video asset</duration>
<url>URL of the video asset</url>
</video>
...
</videos>
</creative>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/video/add

Method Description
Add a video asset to an existing in-stream creative.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the existing
in-stream
integer creative to
creative_id yes
creative_id=222
which this
video asset
must be added.
The MIME type
of the video
file; video/x-flv
for FLV files,
video/x-msstring wmv for WMV type=video/x-ms-wmv
type
yes
files,
video/mp4 for
MP4 files, or
any other valid
video MIME
type.
The video
integer bitrate, in
bitrate
yes
bitrate=256
kilobits/second.
integer The video
height
yes
height=300
height in pixels.
integer The video
width
yes
width=150
width in pixels.
The video
integer
duration yes
duration in
duration=10
seconds.
integer The video URL url=www.video.com/watch?
url
yes
location.
v=5znh58WITU8
Return
<liverailapi requested="/creative/video/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>

...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/video/edit

Method Description
Edit a video asset. The edit method is applied when the creative_id, type, bitrate
and duration are a match (the values are not to be edited). Otherwise, the
methods will actually add a new video. In order to avoid this when you wish to edit
any of the 4 parameters mentioned before, delete the old video using
/creative/video/delete and then add a new video with the new desired parameters.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the existing
in-stream
integer creative to
creative_id yes
creative_id=222
which this
video asset
was already
added.
The MIME type
of the video
file; video/x-flv
for FLV files,
video/x-mswmv for WMV
files,
string video/mp4 for type=video/x-ms-wmv
type
yes
MP4 files, or
any other valid
video MIME
type. Editing
this parameter
will actually
add a new
video.
The video
bitrate, in
kilobits/second.
integer Editing this
bitrate
yes
bitrate=256
parameter will
actually add a
new video.
The video
duration in
seconds.
integer
duration
yes
height
yes
width
yes
url
yes
integer Editing this

duration=10
parameter will
actually add a
new video.
integer The video
height=300
height in pixels.
integer The video
width=150
width in pixels.
integer The video URL url=www.video.com/watch?
location.
v=5znh58WITU8
Return
<liverailapi requested="/creative/video/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/video/upload

Method Description
Upload an asset for an existing video creative. The HTTP POST variable for the
filename is "upload_file". Also, make sure to use HTTP content encoding type as
multipart/form-data.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
existing instream
integer creative to creative_id=222
creative_id yes
which you
want to
upload a
video asset.
Return
<liverailapi requested="/creative/video/upload" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/video/delete

Method Description
Delete existing video assets attached to a creative. You can use a combination of
type and/or bitrate in order to narrow down the video asset(s) you want to delete.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
of the existing
in-stream
creative to
which this
video asset
integer added. If this creative_id=222
creative_id yes
parameter is
the only one
specified, will
delete all the
video assets
attached to the
creative ID.
The MIME type
of the video
file; video/x-flv
for FLV files,
video/x-mswmv for WMV
files,
video/mp4 for
string MP4 files, or type=video/x-ms-wmv
type
no
any other valid
video MIME
type. If
specified, will
delete all the
video assets
with this
particular type.
The video
bitrate, in
kilobits/second.
integer If specified, will bitrate=256
bitrate
no
delete all the
video assets
with this
bitrate.
Return
<liverailapi requested="/creative/video/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
OVERLAY CREATIVES
All the methods related to overlay creatives are displayed here.

/creative/overlay/add
/creative/overlay/edit
/creative/overlay/list
/creative/overlay/upload
/creative/overlay/delete
Method Name: /creative/overlay/list

Method Description
List the overlay attached to an existing creative, if any.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id yes
which the
overlay will be
retrieved.
Return
<liverailapi requested="/creative/overlay/list" api_version="X.Y.Z">
<creative>
<overlays>
<overlay>
<url>the URL of the overlay</url>
<height>the height of the overlay, in pixels</height>
<width>the width of the overlay, in pixels</width>
</overlay>
</overlays>
</creative>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/overlay/add

Method Description
Add an overlay to an existing creative. Please note that a creative can have only
one overlay attached to it.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id yes
which the
overlay will be
added.
string The URL of url=www.test.com
url
yes
the overlay.
The height for
the
integer
height
yes
companion height=300
frame, in
pixels.
The width for
the
integer companion width=150
width
yes
frame, in
pixels.
Return
<liverailapi requested="/creative/overlay/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/overlay/edit

Method Description
Edit an existing overlay.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id yes
which the
overlay will be
added.
string The URL of url=www.test.com
url
no
the overlay.
The height for
the
integer companion height=300
height
no
frame, in
pixels.
The width for
the
width
no
frame, in
pixels.
Return
<liverailapi requested="/creative/overlay/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/overlay/upload

Method Description
Upload an asset for an existing overlay creative. This method returns an upload
URL to which you need to send the asset using HTTP POST. Before POST-ing,
make sure you suffix the upload URL with the following:
'&extension=<overlay_extension>' where <overlay_extension> can be jpg, png or
gif for static images overlays or swf for Flash SWF based overlays. The HTTP
POST variable for the filename is "upload_file". Also, make sure to use HTTP
content encoding type as multipart/form-data.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
existing
overlay
creative_id yes
which you
want to
upload an
asset.
Return
<liverailapi requested="/creative/overlay/upload" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
<url>the upload URL to wich the overlay asset must be uploaded through HTTP POST, suffixed with &extension={jpg|png|gif|swf}</url>
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/overlay/delete

Method Description
Delete an overlay already attached to a creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer creative
creative_id yes
creative_id=222
whose
overlay is
being deleted.
Return
<liverailapi requested="/creative/overlay/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
COMPANIONS
All the methods related to creative companions are displayed here.

/creative/companion/add
/creative/companion/edit
/creative/companion/list
/creative/companion/upload
/creative/companion/delete
Method Name: /creative/companion/list

Method Description
List the companions attached to a creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id
yes
which the
companion is
attached.
The numeric
ID of the
companion
attached to
integer the creative. creative_companion_id=23654
creative_companion_id yes
Must be
specified if no
creative_id is
specified.
Return
<liverailapi requested="/creative/companion/list" api_version="X.Y.Z">
<creative>
<companions>
<companion>
<creative_id>the numeric ID of the creative</creative_id>
<creative_companion_id>the numeric ID of the companion</creative_companion_id>
<width>the companion's frame width, in pixels</width>
<height>the companion's frame height, in pixels</height>
<type>the companion type (image, flash, js, iframe, plain)</type>
<content>the companion's URL or content</content>
<clickthru>clickthru URL for the companion</clickthru>
<iframe>yes|no</iframe>
</companion>
...
</companions>
</creative>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/companion/add

Method Description
Add a companion to a creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id yes
which the
companion
will be added.
The height for
the
height
yes
frame, in
pixels.
The width for
the
width
yes
frame, in
pixels.
The type of
the
companion;
image - for
image
companions,
flash - for
Flash
string animations, js type=js
type
yes
- for
JavaScript
companions,
iframe - for
IFRAME
companions,
plain - for
plain HTML
companions.
The
companion's
string URL or
content yes
content=js
content (js,
iframe, plain).
Specify
whether the
companion is
iframe or not.
The accepted
enum values are iframe=yes
iframe
no
"yes" | "no".
The default
value is "no".
This
parameter is
optional.
The
string companion's clickthru=www.testing.com
clickthru no
clickthru URL.
Return
<liverailapi requested="/creative/companion/add" api_version="X.Y.Z">
<creative_companion_id>the companion numeric ID for the newly added companion</creative_companion_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/companion/edit

Method Description
Edit a creative companion.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
integer ID of the
creative_companion_id=222333
companion to
edit.
The height for
the
height
no
frame, in
pixels.
The width for
the
width
no
frame, in
pixels.
The type of
the
companion;
image - for
image
companions,
flash - for
Flash
string animations, js type=js
type
no
- for
JavaScript
companions,
iframe - for
IFRAME
companions,
plain - for
plain HTML
companions.
The
companion's
string URL or
content
no
content=js
content (js,
iframe, plain).
Specify
whether the
companion is
iframe or not.
The accepted
iframe
no
clickthru
no
enum values are iframe=yes

"yes" | "no".
The default
value is "no".
This
parameter is
optional.
The
string companion's clickthru=www.testing.com
clickthru URL.
Return
<liverailapi requested="/creative/companion/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/companion/upload

Method Description
Uploads an asset for a creative companion. The method will return the upload
URL to which you have to upload the asset for the creative companion using
classical HTTP POST. Make sure that you suffix this URL with the following:
'&extension=<companion_extension>' where <companion_extension> can be jpg,
png or gif for creative companions created with type='image' or swf for creative
companions created with type='flash'. The HTTP POST variable for the filename
is "upload_file". Also, make sure to use HTTP content encoding type as
multipart/form-data.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer companion for creative_companion_id=222333
which the
asset will be
uploaded.
Return
<liverailapi requested="/creative/companion/upload" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
<url>the upload URL to which you need to upload the asset for the creative companion using HTTP POST</url>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/companion/delete

Method Description
Delete a creative companion.
Parameters
Name

Example
token
yes
/login).
integer creative to which the creative_id=222
creative_id
yes
companion is attached.
companion to be
deleted. If no
integer creative_companion_id creative_companion_id=222333
creative_companion_id no
is specified, all the
companions attached
to creative_id will be
deleted.
Return
<liverailapi requested="/creative/companion/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
TRACKERS
All the methods related to creative trackers are displayed here.

/creative/tracker/add
/creative/tracker/edit
/creative/tracker/list
/creative/tracker/delete
Method Name: /creative/tracker/list

Method Description
List the trackers associated with a creative.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID of
the creative for
which the trackers
will be listed. Must
be specified if no
integer creative_tracker_id creative_id=222
creative_id
yes
is given. If you
have multiple id(s)
you can make a
single call by
glueing them
The numeric ID of
the trackers to be
listed. Must be
specified if no
creative_id is
integer given. If you have creative_tracker_id=874687
creative_tracker_id yes
multiple id(s) you
can make a single
call by glueing
them together with
| or ,
The numeric ID of
the main order line
integer for which the
order_line_id
no
order_line_id=o397547
trackers will be
listed.
Return
<liverailapi requested="/creative/tracker/list" api_version="X.Y.Z">
<creative>
<trackers>
<tracker>
<creative_tracker_id>The numeric ID of the tracker</creative_tracker_id>
<creative_id>The numeric ID of the creative</creative_id>
<redirect>yes/no</redirect>
<order_line>The order line.</order_line>
</tracker>
...
</trackers>
</creative>
<user> ... </user>
<auth> ... </auth>

...
</liverailapi>
Change History
Date
28 May
2012
Description
Added creative_tracker_id, order_line_id, updated xml
response
Reason
Align with
API
Method Name: /creative/tracker/add

Method Description
Add a tracker to a creative.
Parameters
Name

Example
token
yes
/login).
integer creative to which the creative_id=222
creative_id yes
tracker will be added.
order line to which the
tracker will be added.
string The correct format
order_line_id yes
starts by letter "o"
followed by the
orderline ID.
The tracker event:
impression impression, accept accept invitation,
clickthru - video clickthrough, view25 - first
quartile (25%
watched), view50 midpoint (50%
watched), view75 third quartile (75%
watched), view100 string complete view (100% event=firstq
event
yes
watched), pause video paused, mute video muted, minimize
- minimize overlay,
close - close,
companion_impression
- companion
impression, error error, skip, custom1
from custom8 - custom
events that can be
send from player
url=http://www.youtube.com/watch?
string url for the tracker.
url
yes
v=YPhhJHrxrCM
Redirect to 3rd party
trackers. The
enum accepted values are: redirect=yes
redirect
yes
"yes" or "no". The
default value is "no".
Return
<liverailapi requested="/creative/tracker/add" api_version="X.Y.Z">

<creative_tracker_id>the numeric ID of the new tracker</creative_tracker_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
11 July 2012
11 September 2012
Description
Reason
Align with API
Align with API
Method Name: /creative/tracker/edit

Method Description
Edit tracker for an existing creative. The unicity of a tracker is determined by the
tuple (creative_id, event, url) thus you can have multiple trackers for the same
creative and for the same event but with different URLs.
Parameters
Name

Example
token
yes
/login).
integer creative on which the creative_id=222
creative_id
yes
tracker will be edited.
integer tracker that will be
creative_tracker_id yes
creative_tracker_id=444222
edited.
order line for which the
string tracker is edited. The order_line_id=o847562
order_line_id
no
correct format starts by
letter "o" followed by
the orderline ID.
The new tracker
event: impression impression, accept accept invitation,
clickthru - video clickthrough, fview25 - first
quartile (25%
watched), view100 string complete view (100% event=accept
event
no
- minimize overlay,
close - close,
- companion
events that can be
send from player
string The new URL of the url=www.trackernew.com
url
no
tracker.
Return
<liverailapi requested="/creative/tracker/edit" api_version="X.Y.Z">

<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
11 July 2012
11 September 2012
Description
Reason
Align with API
Align with API
Method Name: /creative/tracker/delete

Method Description
Delete a tracker for an existing creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer creative from creative_id=222
creative_id
yes
which the
tracker will be
deleted.
The numeric
ID of the
integer
creative_tracker_id no
tracker that creative_tracker_id=444222
will be
deleted.
Return
<liverailapi requested="/creative/tracker/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
CREATIVE ADVERTISER
All the methods related to creative advertisers are displayed here.

/creative/advertiser/add
/creative/advertiser/list
/creative/advertiser/delete
Method Name: /creative/advertiser/list

Method Description
List the advertiser(s) attached to an existing creative(s), if any.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative(s) for
which the
advertisers
will be
integer retrieved. If creative_id=444,999
creative_id yes
you have
multiple id(s)
you can make
a single call
by glueing
them together
with | or ,
Search based
integer on the
advertiser_id no
advertiser_id=9542
numeric ID of
the advertiser.
Return
<liverailapi requested="/creative/advertiser/list" api_version="X.Y.Z">
<advertisers>
<advertiser>
<advertiser_id>The numeric ID of the advertiser.</advertiser_id>
<creative_id>The numeric ID of the creative.</creative_id>
</advertiser>
...
</advertisers>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/advertiser/add

Method Description
Add a new advertiser to an existing creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id yes
which the
advertiser will
be added.
The numeric
ID of the
advertiser to
be added to
the creative. If
there are
integer advertiser at advertiser_id=9542
advertiser_id yes
the creative
campaign
level, adding
new
advertisers
here is not
allowed.
Return
<liverailapi requested="/creative/advertiser/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/advertiser/delete

Method Description
Delete an advertiser from an existing creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative_id yes
which the
advertiser will
be removed.
The numeric
ID of the
advertiser to
be removed
from the
creative.
Deleting
integer advertisers is advertiser_id=9542
advertiser_id yes
not possible
when there
are
advertisers at
the creative
campaign
level.
Return
<liverailapi requested="/creative/advertiser/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
CREATIVE ADVERTISING CATEGORY
All the methods related to creative advertising categories are displayed here.
/creative/advertising/category/add
/creative/advertising/category/list
/creative/advertising/category/delete
Method Name: /creative/advertising/category/list

Method Description
List the advertising category(es) attached to an existing creative(s), if any.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative(s) for
which the
advertising
categories will
integer be retrieved. creative_id=999,655
creative_id
yes
If you have
multiple id(s)
you can make
a single call
by glueing
them together
with | or ,
Search based
on the
integer numeric ID of advertising_category_id=9542
advertising_category_id no
the
advertising
category.
Return
<liverailapi requested="/creative/advertising/category/list" api_version="X.Y.Z">
<advertising_categories>
<advertising_category>
<advertising_category_id>The numeric ID of the advertising category.</advertising_category_id>
</advertising_category>
...
</advertising_categories>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/advertising/category/add

Method Description
Add an advertising category to an existing creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative to
integer which the
creative_id
yes
creative_id=999
advertising
category will
be added.
The numeric
ID of the
integer advertising advertising_category_id=9542
advertising_category_id yes
category to
be added to
the creative.
Return
<liverailapi requested="/creative/advertising/category/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/advertising/category/delete

Method Description
Delete an advertising category from an existing creative.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative from
integer which the
creative_id
yes
creative_id=999
advertising
campaign will
be removed.
The numeric
ID of the
advertising
integer category to advertising_category_id=9542
be removed
from the
creative.
Return
<liverailapi requested="/creative/advertising/category/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
CREATIVE CAMPAIGNS
Create a creative campaign group to organize one group of creatives.

Creative Campaigns
/creative/campaign/add
/creative/campaign/edit
/creative/campaign/list
/creative/campaign/delete
/creative/campaign/resolve/name
Method Name: /creative/campaign/list

Method Description
Displays the information related to a creative. Also, it can be used to list the
creatives attached to a creative group (campaign).
Parameters
Name

Example
token
yes
/login).
The id of the entity for
which you want to get the
list of creative
integer campaigns. If not given, entity_id=999
entity_id
no
this parameter will
automatically get the
value of the current
entity.
One or more creative
campaign id(s). If you
integer have multiple id(s) you campaign_creative_id = 1|7|120 or
can make a single call by campaign_creative_id = 1,7,120
glueing them together
with | or ,
Use this parameter to
return only the creative
groups assigned to one
integer or more advertiser(s). If advertiser_id = 1|7|120 or
advertiser_id
no
you have multiple id(s) campaign_creative_id = 1,7,120
you can make a single
Search based on the
string status of the campaign. status=archived
status
no
Possible values are:
active or archived.
The call will return only
the creative campaigns
that have a name that
matches the search
string string and the creative search_string=music
search_string
no
campaigns that are
asigned to an advertiser
whose name matches the
search string.
integer Limit the number of
limit
no
limit=10
results for pagination(s).
The offset from where
the limit should be
applied ( if you display 10
groups per page and you
need to get the 3rd page
integer you should set offset to offset=20
offset
no
20 and limit to 10). This
parameter must be used
togetjher with limit and
shouldn't be given
without giving the limit
parameter as well.
The order by criteria that
should be applied for the
string list. The supported
order_by
no
order_by=creation_time
values are:
order_type
no
creative_campaign_name
and creation_time.
The order type that
should be applied. The
supported values are:
string asc and desc. This
order_type=asc
parameter shouldn't be
used without setting
order_by as well.
Return
<liverailapi requested="/creative/campaign/list" api_version="X.Y.Z">
<campaigns>
<campaign>
<creative_campaign_id>creative group's ID</creative_campaign_id>
<creation_time>creative group creation full date (YYYY-MM-DD HH:MM:SS)</creation_time>
<creative_campaign_name>the name of the creative group</creative_campaign_name>
<advertiser_id>advertiser's ID</advertiser_id>
<status>active and/or archived</advertiser_id>
<name>advertiser's name</name>
</campaign>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 June 2012
Description
Added status.
Reason
Align with API.
Method Name: /creative/campaign/resolve/name

Method Description
Obtain the creative group (campaign) name for a given creative group (campaign)
numeric ID.
Parameters
Name

Authentication
token
yes
(received
after /login).
The creative
group
(campaign)
for which the
creative
group
(campaign)
name will be
integer returned.
creative_campaign_id=999, 666
Multiple
creative
groups
(campaigns)
ID are
allowed,
separated by
comma (,).
Return
<liverailapi requested="/creative/campaign/resolve/name" api_version="X.Y.Z">
<campaigns>
<campaign>
<creative_campaign_id>creative group (campaign) numeric ID</creative_campaign_id>
<creative_campaign_name>creative group (campaign) name</creative_campaign_name>
</campaign>
....
</campaigns>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /creative/campaign/add

Method Description
Add a new creative group (campaign) and attaches to the current entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The name of
string the creative
creative_campaign_name yes
creative_campaign_name=testing
group.
The numeric ID
of the
advertiser. If
integer "LR_API_NULL" advertiser_id=875
advertiser_id
no
is used, the
advertiser_id
will be cleared.
Return
<liverailapi requested="/creative/campaign/add" api_version="X.Y.Z">
<creative_campaign_id>the numeric ID of the newly created creative group</creative_campaign_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 June 2012
Description
Added advertiser_id.
Reason
Align with API.
Method Name: /creative/campaign/edit

Method Description
Edit a creative group (campaign).
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
integer of the creative creative_campaign_id=876
yes
group to be
edited
The new name
string of the creative creative_campaign_name=testing1
creative_campaign_name no
group.
The numeric ID
of the
advertiser. If
integer "LR_API_NULL" advertiser_id=875
advertiser_id
no
is used, the
advertiser_id
will be cleared.
The status of
the group.
Possible values
are: "active" (for
string active groups), status=archived
status
no
"archived" (for
archived
groups). The
default value is
"active"
Return
<liverailapi requested="/creative/campaign/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
15 June 2012
Description
Added advertiser_id, status.
Reason
Align with API.
Method Name: /creative/campaign/delete

Method Description
Delete an existing creative group (campaign).
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer creative
creative_campaign_id=999
group to be
deleted.
Return
<liverailapi requested="/creative/campaign/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ORDER NUMBERS
All the methods related to the order numbers are displayed here.
/order/number/list
/order/number/resolve/name
/order/number/resolve/name/from/order
Method Name: /order/number/list

Method Description
Returns the order numbers for an entity ( either explicitly given or the current one
).
Parameters
Name

Authentication
token
yes
(received
after /login).
The order
number ID(s).
If you have
multiple ID(s)
string you can make order_number_id = 1|7|120 or
order_number_id no
order_number_id = 1,7,120
a single call
by glueing
them together
with | or ,
TThe id of
the entity for
which you
want to
retrieve the
list of order
string number(s). If entity_id=533
entity_id
no
not given, this
parameter will
automatically
get the value
of the current
entity.
Return only
the order
string numbers that search_string=22
search_string no
contains the
given search
string.
Return
<liverailapi requested="/order/number/list" api_version="X.Y.Z">
<order_numbers>
<order_number>
<id>The id if the order number</id>
</order_number>
...
</order_numbers>
<user>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/number/resolve/name

Method Description
Returns the values for a list of order_number_id(s). This method should be used
when dimension[1,2,3] from statistics was order_number_id and you need to know
the actual order number for the retrieved id(s).
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The
order_number_id(s)
for which you need
to retrieve the order
string number. If you have order_number_id = 1|7|120 or
order_number_id yes
multiple ID(s) you order_number_id = 1,7,120
can make a single
call by glueing
them together with
| or ,
Return
<liverailapi requested="/order/number/resolve/name" api_version="X.Y.Z">
<order_numbers>
<order_number>
<order_number_id>the id if the order number</order_number_id>
<order_number>the order number</order_number>
</order_number>
...
</order_numbers>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/number/resolve/name/from/order

Method Description
Returns the order names for a list of order ID(s).
Parameters
Example
Authentication
token yes
(received after
/login).
The order
ID(s). If you
have multiple
ID(s) you can
make a single
call by glueing
them together
with | or , (
examples: if
string you need to order_id = 1|7|120 or order_id = 1,7,120
order_id yes
get the order
names for
order number
ID(s) 1, 7 and
120 you can
use order_id =
1|7|120 or
order_id =
1,7,120 )
Return
<!-<liverailapi requested="/order/name/resolve/name/from/order" api_version="X.Y.Z">
<orders>
<order>
<order_id>the order ID</order_id>
<order_name>the order name</order_name>
</order>
...
</orders>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
15 January 2013
Description
Added page into CHM
Reason
Align with API
ORDER PACKAGES
Preparing order packages for submission to LiveRails system is straightforward and highly
customizable. Each order package contains one or more order lines, or differential delivery
settings for an Order. An order package has a one-to-many relationship with order lines. Naming
orders can follow any convention.
/order/package/add
/order/package/edit
/order/package/list
/order/package/list/stop
/order/package/delete
/order/package/resolve/name
/order/package/archive
/order/package/staging
/order/package/integration/list
/order/package/get/vast
Method Name: /order/package/list

Method Description
Return the information for an order package or for all order packages attached to
the current entity.
Parameters
Name
token
order_id
search_string
publisher_id
status
has_waiting
has_refused
is_archived
staging

Example
Authentication
yes
(received after
/login).
The ID of the
order for which
the details will be
returned. If null
string (not given), will order_id=77654 or order_id=55432
no
return all orders
owned/targeted
to the current
entity.
Return only the
order packages
that have the
string name, order
no
search_string=camp
number or
order_id
matching the
%search_string%
Return only
orders targeted
to this publisher.
If null (not given),
string will return all
no
publisher_id=3334
orders
owned/targeted
to the current
entity
Return only
orders with this
status. Values:
active, inactive,
string completed. If null status=completed
no
(not given), will
return all orders
owned/targeted
to the current
entity
Return only
orders with this
status. Values: 0,
1. If null (not
string given), will return has_waiting=1
no
all orders
owned/targeted
to the current
entity
Return only
orders with this
status. Values: 0,
1. If null (not
string given), will return has_refused=0
no
all orders
owned/targeted
to the current
entity
Return only
orders with this
status. Values: 0,
1. If null (not
string given), will return is_archived=1
no
all orders
owned/targeted
to the current
entity
Return only
orders with this
status. Values: 0,
1. If null (not
string given), will return staging=0
no
all orders
limit
no
offset
no
owned
no
hide_archived
no
flight_time_start no
time_start
no
order_number_id no
owned/targeted
to the current
entity
Limit the number
integer of the returned kimit=20
results.
integer Specify where to offset=1
start the list from.
The accepted
values are:
yes|no|null. If
yes, only owned
orders will be
retuned, if no,
string only targeted
owned=yes
orders will be
retuned, if null,
all the orders,
both owned and
targeted to the
current entity will
be returned.
Hide the archived
orders. The
enum accepted values hide_archived=no
are "yes" or "no".
The default value
is "yes".
Return only
orders with this
flight time start. If
null (not given),
flight_time_start=2012-07-17 22:00:00
orders
owned/targeted
to the current
entity
Return only
orders with this
flight time end. If
null (not given),
flight_time_end=2013-01-17 22:00:00
orders
owned/targeted
to the current
entity
Return only
orders with this
time start. If null
string (not given), will time_start=2012-12-17 22:00:09
return all orders
owned/targeted
to the current
entity
integer The order
order_number_id=876645342
Return
<liverailapi requested="/order/package/list" api_version="x.y.z">
<orders>
<order>
<order_id>Order Id.</order_id>
<order_ownership>owned|targeted</order_ownership>
<name>Order Name</name>
<comments>Order Comments</comments>
<cost_model>cpm|cpc</cost_model>
<ad_unit_type>ad unit type as defined in /order/package/add</ad_unit_type>
<order_number_id>Order Number Id</order_number_id>
<order_number>Order Number</order_number>
<creation_time>YYYY-MM-DD H:i:s</creation_time>
<time_start>YYYY-MM-DD H:i:s</time_start>
<time_end>YYYY-MM-DD H:i:s the max end_time for the lines attached to this order</time_end>
<network_id>Id for the entity that owns/targeted the order.</network_id>
<organization></organization>
<is_archived>0|1</is_archived>
<is_staging>0|1</is_staging>
<has_waiting>0|1</has_waiting>
<has_refused>0|1</has_refused>
<order_status>completed|active|inactive</order_status>
<order_status_details>Details</order_status_details>
<priority>0|20|50|80|100</priority>
<random_sequencing>1|0 if the order lines in this order are selected randomly or not.</random_sequencing>
<number_of_lines>how many lines are attached to this order</number_of_lines>
<publishers>
<publisher>publisher_id</publisher>
</publishers>
</order>
...
</orders>
<count>number of order packages in the reply without any limit</count>
<user> ... </user>
<auth> ... </auth>

...
</liverailapi>
Change History
Date
21 June 2012
30 July 2012
Description
Added 3 new parameters
Added 1 more parameter
Reason
Align with API
Align with API
Method Name: /order/package/add

Method Description
Add a new order package.
Parameters
Name
token
name
ad_unit_type
cost_model
priority
random_sequencing
aperture_enabled
inte_adxpose_id

Example
Authentication
yes
(received after
/login).
The name of the
string
yes
name=test
new package
The type of the
order package.
The acceped
values are: in instream, ov-bug
- overlay without
take-over, ovtake - overlay
with take-over,
string ov-text - text
no
ad_unit_type=ov
overlay, vpaid-in
- VPAID liniar,
vpaid-ov VPAID nonlinear. Once
specified, it
cannot be
changed via edit
method.
The cost model
of the order
package. The
string accepted values cost_model=cpc
no
are: cpc - cost
per click, cpm cost per
thousands
The priority of
the package.
integer Possible values priority=20
no
are:
0,20,50,80,100.
Order Lines in
this order will be
selected
randomly,
ignoring
sequencing,
set
no
after targeting random_sequencing=1
rules are
applied. The
accepted values
are: "0" or "1".
Default value is
"0".
Enable aperture.
The accepted
set
no
values are: "yes" aperture_enabled=yes
or "no". Default
value is "no"
Specify the
AdXpose
numerical ID.
The default
string value is null. If inte_adxpose_id=785
no
the specified
value is
"LR_API_NULL",
inte_vizu_campaign_id
no
string
inte_vizu_agency_enabled
no
string
inte_doubleverify_client_id
no
string
inte_doubleverify_campaign_id no
string
inte_doubleverify_behavior
no
enum
order_number
no
string
inte_safecount_campaign_id
no
string
inte_safecount_in_enabled
no
enum
the integration
will be cleared.
Specify the Vizu
numerical
campaign ID.
The default
value is null. If
inte_vizu_campaign_id=77
the specified
value is
"LR_API_NULL",
the integration
will be cleared.
Specify if Vizu
Agency is
enabled or not.
The accepted
inte_vizu_agency_enabled=yes
values are "yes"
| "no". The
default value is
"no".
Specify the
DoubleVerify
numerical client
ID. The default
value is null. If
inte_doubleverify_client_id=745
the specified
value is
"LR_API_NULL",
the integration
will be cleared.
Specify the
DoubleVerify
numerical
campaign ID.
The default
value is null. If inte_doubleverify_client_id=112
the specified
value is
"LR_API_NULL",
the integration
will be cleared.
Specify the
DoubleVerify
behavior. The
accepted values
are "R", "B" and
"RB" (Reporting inte_doubleverify_behavior=RB
or Blocking).
The default
value is "R".
This parameter
is optional.
Specify the
order number.
The default
value is null. If
the specified
order_number=72285
value is
"LR_API_NULL",
the integration
will be cleared.
Specify the
Safecount
numerical
campaign ID.
The default
value is null. If inte_safecount_client_id=334
the specified
value is
"LR_API_NULL",
the integration
will be cleared.
Specify if the
Safecount
integration is
enabled or not.
The accepted inte_safecount_in_enabled=yes
values are "yes"
| "no". The
inte_affine_line_item_id
no
string
inte_nielsen_campaign_id
no
string
inte_nielsen_start_age
no
string
inte_nielsen_end_age
no
string
inte_nielsen_alpha_code
no
string
default value is
"no".
Specify the
numerical ID for
the Affine 3rd
party
integration. The
default value is
inte_affine_line_item_id=2346
null. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the
Nielsen
Campaign ID. inte_nielsen_campaign_id=2346
This parameter
is optional.
Specify the
lowest age limit
for the Nielsen
age range
inte_nielsen_start_age=2
report. This
parameter is
optional.
Specify the
highest age limit
for the Nielsen
age range
inte_nielsen_end_age=99
report. This
parameter is
optional.
Specify the
Nielsen alpha
code. This
inte_nielsen_alpha_code=A
parameter is
optional.
Return
<liverailapi requested="/order/package/add" api_version="X.Y.Z">
<order_id>the ID of the order</order_id>
<order_number_id>Order number id if a new order number was created. Can be null</order_number_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
20 March 2012
21 July 2012
30 July 2012
10 September 2012
15 January 2013
Description
Added dv_behavior parameter
Added new params.
Reason
Align with API
Align with API
Align with API
Align with API
Method Name: /order/package/edit

Method Description
Edit the details of an order package.
Parameters
Name
token
order_id
name
priority
random_sequencing

Example
Authentication
yes
(received after
/login).
The numerical
string ID of the order order_id=77654
yes
to be edited.
The new name
of the package.
This parameter
is optional,
string meaning that, if name=test
no
not given, the
parameter value
is not altered in
any way.
The priority of
the package.
Possible values
are:
0,20,50,80,100.
integer This parameter priority=20
no
is optional,
meaning that, if
not given, the
parameter value
is not altered in
any way.
Order Lines in
this order will be
selected
randomly,
ignoring
sequencing,
after targeting
rules are
applied. The
set
no
random_sequencing=1
accepted values
are: "0" or "1".
This parameter
is optional,
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify the
order number.
This parameter
is optional,
meaning that, if
order_number
no
string
inte_adxpose_id
no
string
inte_vizu_campaign_id
no
string
inte_vizu_agency_enabled
no
string
inte_doubleverify_client_id
no
string
not given, the

parameter value
order_number=72285
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the
AdXpose
numerical ID.
This parameter
is optional,
meaning that, if
not given, the
parameter value inte_adxpose_id=785
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the Vizu
numerical
campaign ID.
This parameter
is optional,
inte_vizu_campaign_id=77
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify if Vizu
Agency is
enabled or not.
The accepted
values are "yes"
| "no". This
parameter is
inte_vizu_agency_enabled=yes
optional,
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify the
DoubleVerify
numerical client
ID. This
parameter is
optional,
meaning that, if
not given, the
parameter value
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the
DoubleVerify
numerical
campaign ID.
inte_doubleverify_campaign_id no
string
inte_doubleverify_behavior
no
enum
order_number
no
string
inte_safecount_campaign_id
no
string
inte_safecount_in_enabled
no
enum
This parameter
is optional,
meaning that, if
not given, the
parameter value
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the
DoubleVerify
behavior. The
accepted values
are "R", "B" and
"RB" (Reporting
or Blocking).
inte_doubleverify_behavior=RB
This parameter
is optional,
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify the
order number.
This parameter
is optional,
meaning that, if
not given, the
parameter value
order_number=72285
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the
Safecount
numerical
campaign ID.
This parameter
is optional,
meaning that, if
not given, the
inte_safecount_client_id=334
parameter value
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify if the
Safecount
integration is
enabled or not.
The accepted
values are "yes"
| "no". This
inte_safecount_in_enabled=yes
parameter is
optional,
meaning that, if
not given, the
inte_affine_line_item_id
no
string
inte_nielsen_campaign_id
no
string
inte_nielsen_start_age
no
string
inte_nielsen_end_age
no
string
inte_nielsen_alpha_code
no
string
parameter value
is not altered in
any way.
Specify the
numerical ID for
the Affine 3rd
party
integration. This
parameter is
optional,
meaning that, if
not given, the inte_affine_line_item_id=2346
parameter value
is not altered in
any way. If the
specified value
is
"LR_API_NULL",
the integration
will be cleared.
Specify the
Nielsen
Campaign ID.
This parameter
is optional,
inte_nielsen_campaign_id=2346
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify the
lowest age limit
for the Nielsen
age range
report. This
parameter is
inte_nielsen_start_age=2
optional,
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify the
highest age limit
for the Nielsen
age range
report. This
parameter is
inte_nielsen_end_age=99
optional,
meaning that, if
not given, the
parameter value
is not altered in
any way.
Specify the
Nielsen alpha
code. This
parameter is
optional,
inte_nielsen_alpha_code=A
meaning that, if
not given, the
parameter value
is not altered in
any way.
Add comments
regarding the
comments
no
order package.
This parameter
string is optional,
comments=test package.
meaning that, if
not given, the
parameter value
is not altered in
any way.
Return
<liverailapi requested="/order/package/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
20 March 2012
21 July 2012
30 July 2012
10 September 2012
15 January 2013
Description
Added dv_behavior parameter
Added new params.
Reason
Align with API
Align with API
Align with API
Align with API
Method Name: /order/package/delete

Method Description
Delete an owned order package and all the order lines attached to it.
Parameters
Example
Authentication
token yes
(received after
/login).
The numerical
string ID of the order order_id=77654
order_id yes
package to be
deleted.
Return
<liverailapi requested="/order/package/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/package/get/vast

Method Description
Retrieve the VAST for a specific publisher.
Parameters
Name

Example
Authentication
token
yes
(received
after /login).
The numeric
ID of the
publisher
corresponding
to the
order_id for
which the
VAST is
generated.
This
parameter
must be
specified if no
order_id or
order_line_id
is given. If
string you have
publisher_id no
publisher_id=1,7,120
multiple id(s)
you can make
a single call
by gluing
them together
with | or , (
examples: if
you need to
get the
information for
id(s) 1, 7 and
120 you can
use
publisher_id =
1|7|120 or
publisher_id =
1,7,120 ).
The numeric
ID of the
order. This
parameter
must be
order_id
no
order_line_id no
must be
specified if no
publisher_id
or
order_line_id
is given. If
you have
multiple id(s)
you can make
a single call
by gluing
them together
with | or , (
string examples: if order_id=1,7,120
you need to
get the
information for
id(s) 1, 7 and
120 you can
use order_id
= 1|7|120 or
order_id =
1,7,120 ). The
orders must
be all either
owned or
targeted, a
combination
of the two
order types is
not accepted.
TThe numeric
ID of the
order line.
This
parameter
must be
specified if no
publisher_id
or order_id is
given. If you
have multiple
id(s) you can
make a single
call by gluing
them together
with | or , (
examples: if
you need to
string get the
order_line_id=1,7,120
information for
id(s) 1, 7 and
120 you can
use
order_line_id
= 1|7|120 or
order_line_id
= 1,7,120 ).
The order
lines must be
all either
owned or
targeted, a
combination
of the two
order line
types is not
accepted.
Return
<liverailapi requested="/order/package/get/vast" api_version="X.Y.Z">
<tags>
<tag>URL of the VAST</tag>
...
</tags>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/package/archive

Method Description
Sets the archived status for one or more order(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
order(s) to be
archived. If
you have
multiple id(s)
you can make
a single call
by glueing
them together
integer with | or , ( order_id=1,7,120
order_id yes
examples: if
you need to
modify the
orders with
the id(s) 1, 7
and 120 you
can use
order_id =
1|7|120 or
order_id =
1,7,120 ).
Set the order
line to be
archived. The
accepted
enum values are is_archived=yes
is_archived yes
"yes" or "no".
Cannot be
used for
active order
lines.
Return
<liverailapi requested="/order/package/archive" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>

...
</liverailapi>
Change History
Date
21 June 2012
Description
Added page into CHM
Reason
Align with API
Method Name: /order/package/staging

Method Description
Sets one or more order(s) as staging.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
order(s) to be
set to staging.
If you have
multiple id(s)
you can make
a single call
by glueing
them together
integer with | or , ( order_id=1,7,20
order_id yes
examples: if
you need to
modify the
orders with
the id(s) 1, 7
and 120 you
can use
order_id =
1|7|120 or
order_id =
1,7,120 ).
Set the order
line to be set
to staging.
enum The accepted is_staging=yes
is_staging yes
values are
"yes" or "no".
The default
value is "yes".
Return
<liverailapi requested="/order/package/staging" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>

...
</liverailapi>
Change History
Date
15 January 2013
Description
Added page into CHM
Reason
Align with API
Method Name: /order/package/integration/list

Method Description
Return the integration information for an order packagage.
Parameters
Authentication
token yes
(received
after /login).
The ID of the
order(s) for
which the
details will be
returned. If
you have
multiple id(s)
you can make
a single call
by glueing
integer them together order_id=1,7,120
order_id yes
with | or , (
examples: if
you need to
get the order
names for
id(s) 1, 7 and
120 you can
use order_id
= 1|7|120 or
order_id =
1,7,120 ).
Return
<liverailapi requested="/order/package/integration/list" api_version="x.y.z">
<orders>
<order>
<order_id>The order ID</order_id>
<inte_vizu_campaign_id>integration value</inte_vizu_campaign_id>
<inte_vizu_agency_enabled>yes|no</inte_vizu_agency_enabled>
<inte_adxpose_id>integration value</inte_adxpose_id>
<inte_doubleverify_client_id>integration value</inte_doubleverify_client_id>
<inte_doubleverify_campaign_id>integration value</inte_doubleverify_campaign_id>
<inte_doubleverify_behavior>integration value</inte_doubleverify_behavior>
<inte_aperture_enabled>yes|no</inte_aperture_enabled>
<inte_safecount_campaign_id>integration value</inte_safecount_campaign_id>
<inte_safecount_in_enabled>yes|no</inte_safecount_in_enabled>
<inte_affine_line_item_id>integration value</inte_affine_line_item_id>
<inte_evidon_client_id>integration value</inte_evidon_client_id>
<inte_evidon_campaign_id>integration valueL</inte_evidon_campaign_id>
<inte_truste_id>integration value</inte_truste_id>
<inte_nielsen_campaign_id>integration value</inte_nielsen_campaign_id>
<inte_nielsen_start_age>integration value</inte_nielsen_start_age>
<inte_nielsen_end_age>integration value</inte_nielsen_end_age>
<inte_nielsen_alpha_code>integration value</inte_nielsen_alpha_code>
</order>
...
</orders>
<user> ... </user>
<auth> ... </auth>

...
</liverailapi>
Change History
Date
15 January 2013
Description
Added page into CHM
Reason
Align with API
Method Name: /order/package/resolve/name

Method Description
Returns the order names for a list of order id(s). This method should be used
when dimension[1,2,3] from statistics was order_id and you need to know the
actual names for the retrieved id(s).
Parameters
Example
Authentication
token yes
(received after
/login).
The numerical
ID of the order
string package for order_id=77654
order_id yes
which the
name will be
returned.
Return
<liverailapi requested="/order/package/resolve/name" api_version="X.Y.Z">
<orders>
<order>
<order_id>the order id</order_id>
<name>the order name</name>
</order>
...
</orders>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
ORDER LINES
A LiveRail ad campaign consists of one or several order lines in an order package. A campaigns
delivery settings are defined in each order line. An order line contains the required delivery
settings, including:
Flight period: start and end calendar date, hour, and minute.;
Frequency capping
Stop policy
Over-delivery policy
Creatives assigned
Costing information
Site (Publisher, Partner, Network, Marketplace) Selection
Targeting
Order Lines
These are the methods used to handle Order Lines:
/order/line/add
/order/line/edit
/order/line/list
/order/line/list/stop
/order/line/delete
/order/line/staging
/order/line/min/start/date
/order/line/max/end/date
/order/line/resolve/name
/order/line/marketplace/attach
/order/line/network/status/set
/order/line/publisher/status/set
/order/line/creative/list
/order/line/publisher/list
Attaching Creatives
/order/line/creative/attach
/order/line/creative/detach
Attaching Sites
/order/line/site/attach
/order/line/site/detach
Targeting
/order/line/targeting/set
/order/line/targeting/list
/order/line/targeting/delete
Marketplace Targeting
/order/line/marketplace/targeting/set
/order/line/marketplace/targeting/list
/order/line/marketplace/targeting/delete
Frequency Capping
/order/line/frequency/set
/order/line/frequency/list
/order/line/frequency/delete
Method Name: /order/line/list

Method Description
Get a list with owned/targeted order lines. Order ID OR Order Line ID are required.
Parameters
Name

Example
Authentication
token
yes
(received
after /login).
Must be
specified if no
order_line_id
value is
provided.
string returns all the order_id=o987365
order_id
yes
order lines
corresponding
to the
specified
order_id.
Must be
specified if no
order_id value
is provided.
string returns the order_line_id=o8174535
order_line_id yes
details
corresponding
to the
specified
order_line_id.
Return only
string order lines cost_model=cpc
cost_model
no
with this
cost_model.
Return only
string order lines ad_unit_type=
ad_unit_type no
with this
ad_unit_type.
Order line
flight start full
string date. Format flight_time_start=2011-12-01 12:00:00
is: YYYY-MMDD
HH:MM:SS
Order line
flight end full
string date. Format flight_time_end=2011-12-09 12:00:00
flight_time_end no
is: YYYY-MMDD
HH:MM:SS
Return only
integer orders
publisher_id
no
publisher_id=34645
targeted to
this publisher.
Return only
integer orders
network_id
no
network_id=6777
targeted by
this network.
The possible
integer values are
stop
no
stop=yes
"yes", "no".
Return
<liverailapi requested="/order/line/list" api_version="X.Y.Z">
<lines>
<line>
<line_type>The type of the order line</line_type>
<line_ownership>Status of the order line (owned/targeted)</line_ownership>
<line_id>Line Id.</line_id>
<order_id>Order Id</order_id>
<network_id>The numerical ID of the network/entity.</network_id>
<network_name>The name of the network/entity</network_name>
<order_line_name>The name of the Order Line</order_line_name>
<is_template>Template OL (yes/no)</is_template>
<time_start>YYYY-MM-DD H:m:s</time_start>
<time_end>YYYY-MM-DD H:m:s</time_end>
<timezone>float</timezone>
<order_line_index>integer</order_line_index>
<creation_time>YYYY-MM-DD H:m:s</creation_time>
<creative_rotation_type>string</creative_rotation_type>
<position>The position of the order line, with returned value as bit mask.</position>
<ad_unit_type>string</ad_unit_type>
<line_status>active|inactive|completed|waiting|refused. This is the full status for all the lines.</line_status>
<global_status>N/A|inactive. If the line is received from someone that received the line from someone else.
Eg, at your level the line is active, but higher up the tree the line is paused.</global_status>
<daytimes>char array</daytimes>
<stop_by>budget/impression</stop_by>
<dynamic_price></dynamic_price>
<over_delivery>yes|no</over_delivery>
<uniform_pacing>yes|no</uniform_pacing>
<uniform_pacing_value>Float value</uniform_pacing_value>
<optimize_by>none|clicks|complete_rate|25_rate|50_rate|75_rate.</optimize_by>
<settings>
<stop_method>string</stop_method>
<stop></stop>
<stop_type></stop_type>
<buffer></buffer>
<marketplace_bid_type>cpm</marketplace_bid_type>
<marketplace_max_bid_value>55.00</marketplace_max_bid_value>
<over_delivery>yes/no</over_delivery>
</settings>
<publishers>
all publishers attached to this line. If you forwarded this line
(eg you also received it) your entity will be among the publishers
and the values from that entry are the settings you received
the line with.
<publisher>
<publisher_id>integer</publisher_id>
<publisher_name>string</publisher_name>
<stop>integer</stop>
<stop_type>string</stop_type>
<buffer>float</buffer>
<cost_method>string</cost_method>
<publisher_cost>float</publisher_cost>
<gross_rate>float</gross_rate>
<cost_model>cpm|cpc</cost_model>
<line_site_status>active|inactive|completed|waiting|refused. This is the status for this publisher</line_site_status>
<resumable>1|0 if not auto_paused or completed</resumable>
<over_delivery>yes|no</over_delivery>
<uniform_pacing>yes|no</uniform_pacing>
<uniform_pacing>Float value</uniform_pacing>
<pacing_value>If uniform_pacing is not enabled, the value for this is always 1. If uniform_pacing is enabled,
the value reflects the state of the delivery.</pacing_value>
</publisher>
<statistics_order_line_id>string</statistics_order_line_id>
<statistics_order_id>string</statistics_order_id>
<resumable>0|1</resumable>
<delivery_completed>0|1</delivery_completed>
...
</publishers>
<marketplaces>
<marketplace>
<publisher_id>The numerical ID of the publisher</publisher_id>
<publisher_name>The publisher's ID</publisher_name>
<stop>float</stop>
<stop_type>string</stop_type>
<buffer>float</buffer>
<marketplace_bid_type>cpm|cpc</marketplace_bid_type>
<marketplace_max_bid_value>float</marketplace_max_bid_value>
<pacing_value>If uniform_pacing is not enabled, the value for this is always 1. </pacing_value>
<line_site_status>active|inactive|completed|waiting|refused</line_site_status>
<statistics_order_line_id>Order Line ID</statistics_order_line_id>
<statistics_order_id>Order ID</statistics_order_id>
<resumable>1/0</resumable>
</marketplace>
...
</marketplaces>
<creatives>
<creative>
<creative_id>integer</creative_id>
<title>string</title>
<creative_campaign_id>integer</creative_campaign_id>
<creative_rotation_weight>float</creative_rotation_weight>
<status>string</status>
<adtag>string</adtag>
<clickthru>the clickthru for the line-creative attachment.</clickthru>
<creative_click_rate>float</creative_click_rate>
<creative_complete_rate>float</creative_complete_rate>
</creative>
...
</creatives>
</line>
...
</lines>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/add

Method Description
Add a new order line to an existing order package - more text is needed
Related Methods
/advertiser/list
/creative/list
Parameters
Name
Required Type
Overview
Example
Authentication
session
token
string
The order package ID to
string
which this order line will be
order_id=o987365
attached.
Order line flight start full date.
string
Format is: YYYY-MM-DD
time_start=2011-12-01 12:00:00
HH:MM:SS
Order line flight end full date.
string
time_end=2011-12-09 12:00:00
HH:MM:SS
float|integer Timezone for the order line
timezone=2.5
flight start and full date.
The name for the new order
string
order_line_name=testline
line.
The Stop type. Must be
specified when
integer
line_type=marketplace.
stop=876
Default value is
LR_API_NULL.
Specify as "marketplace" if
you want to attach the
orderline to a
marketplace/LRC (possible
enum
line_type=marketplace
values: "site", "marketplace").
Default value is "site". This
parameter cannot be edited
once specified here.
Order line CPM price for cpm
float|integer orders or CPC price for cpc gross_rate=xyz
orders.
Publisher's rate for this order
float|integer line, CPM price for cpm orders net_to_publisher=12.8
or CPC price for cpc orders.
This parameter should be
used when a marketplace is
attached. Only positive values
float|integer are accepted. Must be
max_bid=4.2
specified if
line_type=marketplace.
Default value is "null".
Position of the order line in
relation with the other order
integer
order_line_index=7
lines from the current
package.
The stop level. The possible
values are: line_level,
enum
stop_method=site_level
token
yes
order_id
yes
time_start
yes
time_end
yes
timezone
yes
order_line_name
yes
stop
no
line_type
no
gross_rate
no
net_to_site
no
max_bid
no
order_line_index
no
stop_level
no
stop_level
no
enum
stop_period
no
enum
stop_by
no
enum
over_delivery
no
enum
over_delivery_percent no
percent
uniform_pacing
enum
no
uniform_pacing_value no
float
optimize_by
no
enum
daytimes
no
string
creative_rotation_type no
enum
position
enum
no
stop_method=site_level
site_level. Default value is:
line_level.
The order line's stop period.
The possible values are: daily,
stop_type=daily
total. The default value is
total.
The order line's stop
condition. The possible values
are: impressions, budget. The
stop_by=budget
default value is impressions.
This parameter cannot be
edited once specified here.
Specify if over delivery is
allowed. The possible values over_delivery=no
are: yes, no.
Specify the percent for over
over_delivery_percent=75
delivery, if over_delivery=yes.
Specify if there is uniform
pacing. The possible values uniform_pacing=yes
are: yes, no.
Acceptes values: any float
number from 0 to 100. Default uniform_pacing_value=4.2
value is 0.
Optimization criteria. The
acccepted value is none, and
if the following parameter is
specified as
"line_type=marketplace", the
optimize_by=clicks
following values will be
accepted as well: clicks,
complete_rate, 25_rate,
50_rate, 75_rate. The default
value is "none".
7*24 long character array for
each hour of the week. 1 shows ads in that hour, 0 - do daytimes=22222223333333
not show ads in that hour.
Default = 1...1
The creatives' rotation logic.
The possible values are:
"random", "weighted delivery"
creative_rotation_type=optimize_by_ctr
"optimized_by_ctr",
"optimized_by_complete_rate".
The default value is "random".
The position of the order line,
with accepted values as bit
mask: 1(PRE), 2(MID),
4(POST). The default value is
'null' It becomes mandatory
position=2
when "ad_unit_type=in" for the
order package. To check the
value of "ad_unit_type" in the
OP use /order/package/list.
Return
<liverailapi requested="/order/line/add" api_version="X.Y.Z">
<order_line_id>the ID of the newly added order line</order_line_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/edit

Method Description
Edit an owned order line.
Related Methods
/advertiser/list
/creative/list
Parameters
Name
optuired Type
token
yes
order_line_id
no
time_start
no
time_end
no
timezone
no
gross_rate
no
order_line_name
no
stop
no
gross_rate
no
net_to_site
no
max_bid
no
order_line_index
no
creative_rotation_type no
Overview
Example
Authentication
session
token
string
The numerical ID of the order
string
line to be edited, the same
returned by /order/line/list.
Order line flight start full date.
string
time_start=2011-12-01 12:00:00
HH:MM:SS
Order line flight end full date.
string
time_end=2011-12-09 12:00:00
HH:MM:SS
float|integer Timezone for the order line
timezone=o987365
flight start and full date.
float|integer orders or CPC price for cpc gross_rate=2.5
orders.
The name for the new order
string
order_line_name=testline
line.
meaning that, if not given, the
integer
stop=876
parameter value is not altered
in any way.
float|integer orders or CPC price for cpc gross_rate=xyz
orders.
Publisher's rate for this order
float|integer line, CPM price for cpm orders net_to_site=12.8
or CPC price for cpc orders.
Only positive values are
accepted. This parameter is
float
optional, meaning that, if not max_bid=7.3
Position of the order line in
relation with the other order
integer
order_line_index=7
lines from the current
package.
The creatives' rotation logic.
"random", "weighted delivery",
"optimized_by_ctr",
enum
"optimized_by_complete_rate". creative_rotation=random
in any way.
The postition of the order line,
position
no
integer
stop_level
no
enum
stop_type
no
enum
over_delivery
no
enum
percent
uniform_pacing
enum
no
uniform_pacing_value no
float
optimize_by
no
enum
daytimes
no
string
with accepted values as bit

mask: 1(PRE), 2(MID),
4(POST). This parameter is position=2
The order line's stop method.
line_level, site_level. This
stop_level=site_level
in any way.
The order line's stop type. The
possible values are: daily,
total. This parameter is
stop_type=total
Specify if over delivery is
allowed. The possible values
are: yes, no. This parameter is
over_delivery=no
Specify the percent for over
delivery, if over_delivery=no.
over_delivery_percent=75
in any way.
Specify if there is uniform
pacing. The possible values
are: yes, no. This parameter is
uniform_pacing=no
Acceptes values: any float
number from 0 to 100. This
uniform_pacing_value=4.2
in any way.
Optimization criteria. The
acccepted value is none, and
if the following parameter is
specified as
"line_type=marketplace", the
optimize_by=clicks
following values will be
accepted as well: clicks,
complete_rate, 25_rate,
50_rate, 75_rate. The default
vale is "none".
7*24 long character array for
each hour of the week. 1 shows ads in that hour, 0 - do daytimes=22222223333333...
not show ads in that hour.
Default = 1...1
Return
Change History
Date
Description
Reason
Method Name: /order/line/delete

Method Description
Delete an order line.
Related Methods
There is 1 related method for this method:
/order/line/add
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical
ID of the order
line to be
string
order_line_id yes
deleted (the
same as
returned from
/order/line/add).
Return
<liverailapi requested="/order/line/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/list/stop

Method Description
Get a list with Booked impressions. Order Line ID is required.
Parameters
Name

Example
Authentication
token
yes
(received
after /login).
Returns the
details
string corresponding order_line_id=o8174535
order_line_id yes
to the
specified
order_line_id.
Return
<liverailapi requested="/order/line/list" api_version="X.Y.Z">
<order_line_stops>
<order_line_stop>
<stop>0</stop>
</order_line_stop>
</order_line_stops>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/list/min/start/date

Method Description
List the minimum start date for the order lines.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative.
Required if no
order_id,
publisher_id
string or
creative_id yes
creative_id=3421
order_line_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
The numeric
ID of the
order.
Required if no
creative_id,
publisher_id
string or
order_id
yes
order_id=o987365
order_line_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
The numeric
ID of the
publisher.
Required if no
order_id,
string creative_id or publisher_id=665
publisher_id yes
order_line_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
The numeric
ID of the
order line.
Required if no
order_id,
publisher_id
string
order_line_id yes
or creative_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
Return
<liverailapi requested="/order/line/list/min/start/date" api_version="X.Y.Z">
<min_start_date>Date and time of the minimum start date in format: YYYY-MM-DD HH:MM:SS</min_start_date>
<user> ... </user>
<auth> ... </auth>
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/list/max/end/date

Method Description
List the maximum end date for the order lines.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
creative.
Required if no
order_id,
publisher_id
string or
creative_id yes
creative_id=3421
order_line_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
The numeric
ID of the
order.
Required if no
creative_id,
publisher_id
string or
order_id
yes
order_id=o987365
order_line_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
The numeric
ID of the
publisher.
Required if no
order_id,
string creative_id or publisher_id=665
publisher_id yes
order_line_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
The numeric
ID of the
order line.
Required if no
order_id,
string publisher_id order_line_id=o945365
order_line_id yes
or creative_id
is provided.
Multiple IDs
can be used,
separated by
comma (,)
Return
<liverailapi requested="/order/line/list/max/end/date" api_version="X.Y.Z">
<max_end_date>Date and time of the maximum end date in format: YYYY-MM-DD HH:MM:SS</max_end_date>
<user> ... </user>
<auth> ... </auth>
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/publisher/list

Method Description
Get all publishers for an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string
order_line_id yes
of the order
line.
Return
<liverailapi requested="/order/line/publisher/list" api_version="X.Y.Z">
<publishers>
<publisher>
<net_to_site_method></net_to_site_method>
<net_to_site>Float value</net_to_site>
<max_bid>Max bid value</max_bid>
<stop>Stop time</stop>
<stop_period>Stop period</stop_period>
<line_site_status>Line site status</line_site_status>
<line_site_status_details>Line site status details</line_site_status_details>
<over_delivery_percent>Percent value</over_delivery_percent>
<pacing_value>float value</pacing_value>
</publisher>
</publishers>
<count>Number of returned publishers</count>
<user>...</user>
<auth>...</auth>
...
Change History
Date
Description
Reason
Method Name: /order/line/resolve/name

Method Description
Returns the order line names for a list of order line id(s). This method should be
used when dimension[1,2,3] from statistics was order_line_id and you need to
know the actual names for the retrieved id(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
The order line
id(s). If you
have multiple
id(s) you can
string make a single order_line_id = 1|7|120 or order_line_id =
order_line_id yes
1,7,120
call by
glueing them
together with
| or ,
Return
<liverailapi requested="/order/line/resolve/name" api_version="X.Y.Z">
<order_lines>
<order_line>
<order_line_id>the id of the order line</order_line_id>
<order_line_name>the name of the order line</order_line_name>
</order_line>
...
</order_lines>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/network/status/set

Method Description
Sets the order line and publisher level status. Only the network with the access
rights on the order can change the status.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
string numerical ID order_line_id=794564
order_line_id yes
of the order
line.
The status of
the order line.
enum The possible status=active
status
yes
values are:
"active",
"passive"
The
publisher's
numerical ID.
string This
publisher_id no
publisher_id=2453
parameter is
optional with
default value
"null".
Return
<liverailapi requested="/order/line/network/status/set" api_version="x.y.z">
<user> ... </user>
<auth> ... </auth>
<warnings>
<warning>
<message>The reason why the status can't be changed for a publisher.</message>
<code></code>
</warning>
<warning>
<message>If the line status changed successful, the reason why the line status is still inactive.</message>
<code></code>
</warning>
...
</warnings>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/publisher/status/set

Method Description
Sets the order line and publisher level status. Only the publisher with the access
rights on the order can change the status.
Parameters
Name

Example
token
yes
/login).
The order line
numerical ID. To
string retrieve its publisher, order_line_id=794564
order_line_id yes
use
/order/line/publisher/list
The status of the order
enum line. The possible
status
yes
status=active
values are: "active",
"passive"
Return
<liverailapi requested="/order/line/publisher/status/set" api_version="x.y.z">
<user> ... </user>
<auth> ... </auth>
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/staging

Method Description
Sets the status for an order line to Staging or Production.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
order line(s)
for which the
status is
changed. If
you have
multiple id(s)
you can make
a single call
by glueing
integer them together order_line_id=o8125245
order_line_id yes
with | or , (
examples: if
you need to
modify the
order lines
with the id(s)
1, 7 and 120
you can use
order_line_id
= 1|7|120 or
order_line_id
= 1,7,120 ).
Set the order
line to be
staged. The
accepted
values are
"yes" or "no" (
if no is used,
enum
is_staging yes
the OL will be is_staging=yes
set as
Production ).
Cannot be
used for order
lines with
"archived"
status.
status.
Return
<liverailapi requested="/order/line/staging" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
21 June 2012
Description
Added page into CHM
Reason
Align with API
Method Name: /order/line/marketplace/attach

Method Description
Attach an order line to a marketplace.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the
string orderline to order_line_id=o987365
order_line_id yes
be attached
to the
marketplace.
The
numerical ID
of the
publisher to
which the OL
integer will be
publisher_id yes
publisher_id=365
attached. The
publisher
must be a
marketplace,
no other type
will function.
Return
<liverailapi requested="/order/line/marketplace/attach" api_version="X.Y.Z">
<emails>
<email></email>
</emails>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/creative/list

Method Description
List all the available creatives.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
order line for
which the
information
will be
string returned. If order_line_id = 1|7|120 or order_line_id =
order_line_id no
you have
1,7,120
multiple ID(s)
you can make
a single call
by glueing
them together
with | or ,
Return
<liverailapi requested="/order/line/creative/list" api_version="X.Y.Z">
<creatives>
<creative>
<creative_id>the numercical ID of the creative</creative_id>
<order_line_id>the numerical ID of the order line</order_line_id>
<title>creative title</title>
<creative_campaign_id>the numercical ID of the creative campaign</creative_campaign_id>
<creative_rotation_weight>the rotation weight</creative_rotation_weight>
<status>the status</status>
<adtag>the adtag</adtag>
<clickthru>The clickthrough URL</clickthru>
<creative_click_rate>click rate</creative_click_rate>
<creative_complete_rate>complete rate</creative_complete_rate>
</creative>
</creatives>
<count>Number of returned publishers</count>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
24 January 2013
Description
Method added in chm
Reason
Align with API
Method Name: /order/line/integration/list

Method Description
Get a list with the integrations available for an order line. Only the entity with the
access rights on the order can retrieve this info.
Parameters
Name

Authentication
token
yes
(received
after /login).
If you have
multiple id(s)
you can make
a single call
by glueing
them together
with | or , (
examples: if
string you need to order_line_id=1,7,120
order_line_id yes
get the
integrations
for id(s) 1, 7
and 120 you
can use
order_line_id
= 1|7|120 or
order_line_id
= 1,7,120 )
Return
<!-<liverailapi requested="/order/line/integration/list" api_version="x.y.z">
<lines>
<line>
<order_line_id>The order line ID/order_line_id>
<inte_nielsen_placement_id>Value of the integration</inte_nielsen_placement_id>
</line>
</lines>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ATTACHING CREATIVES
These are the methods related to attaching creatives

/order/line/creative/attach
/order/line/creative/detach
Method Name: /order/line/creative/attach

Method Description
Attach a creative to an order line.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical ID of
string the order line to
order_line_id yes
which the creative
will be attached.
The numerical ID of
integer the creative to be creative_id=365
creative_id yes
attached to the
order line.
This parameter only
makes sense when
the order line's
rotation is
"weighted_delivery".
In all other cases,
this parameter is
ignored. Delivery is
float accomplished
weight
no
weight=2.5
according to the
number of creatives
and their weight: for
example, if 2
creatives have 40
weight (20 each),
delivery will be
done 50% for each.
Return
<liverailapi requested="/order/line/creative/attach" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Date
02
Description
Reason
Method Name: /order/line/creative/detach

Method Description
Detach a creative from an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the order
string line from
order_line_id yes
which the
creative will
be detached.
The
numerical ID
of the
creative_id yes
which the
order line will
be detached.
Return
<liverailapi requested="/order/line/creative/detach" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ATTACHING SITES
These are the methods related to attaching sites

/order/line/site/attach
/order/line/site/detach
Method Name: /order/line/site/attach

Method Description
Attaches owned/forwarded line to a site.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
string The numerical ID of order_line_id=o794564
order_line_id
yes
the order line.
string The numerical ID of publisher_id = 2453
publisher_id
yes
the publisher.
How the cost is
calculated for this
site. The possible
values are:
"line","site","custom".
The default value is
custom. line - use
string net_to_publisher
cost_method
no
cost_method=line
from /order/line/add
or
/order/line/forward.
site - use value from
/site/settings/set.
custom - use value
from cost field.
This value is used
float when cost_method cost=22.5
cost
no
is custom.
The order line's stop
type. The possible
set
stop
no
values are: daily,
stop=total
total. The default
value is total.
This value is used
when /order/line/add
or
/order/line/forward
stop_method is
string "site_level". Default stop_type=???
stop_type
no
value: "null". This
parameter is
required when
/order/line/add
stop_by is "budget".
float Specify the
over_delivery_percent=5.5
overdelivery cap.
Return
<liverailapi requested="/order/line/site/attach" api_version="X.Y.Z">
If the user(s) attached to the publisher have a role of "cust-ro" and they accept emails, the list with emails.
<emails>
<email>email address</email>
...
</emails>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/set/detach

Method Description
Detach a site from an owned/forwarded line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
string numerical ID order_line_id=o794564
order_line_id yes
of the order
line.
The
string numerical ID publisher_id = 2453
publisher_id yes
of the
publisher.
Return
<liverailapi requested="/order/line/site/detach" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
</liverailapi>
Change History
Date
Description
Reason
TARGETING
These are the methods related to targeting

/order/line/targeting/set
/order/line/targeting/list
/order/line/targeting/delete
Method Name: /order/line/targeting/list

Method Description
Get all the rules for an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The order line
ID(s) for
which the info
will be
returned. If
string you have
order_line_id yes
order_line_id=1,7,120
multiple id(s)
you can make
a single call
by glueing
them together
with | or ,
Return
<liverailapi requested="/order/line/targeting/list" api_version="X.Y.Z">
<rules>
<rule>
<order_line_id></order_line_id>
<rule>current level rule</rule>
</rule>
</rules>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/targeting/set

Method Description
Set the targeting rule for an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string of the order order_line_id=987365
order_line_id yes
line for which
the capping is
modified.
string The rule to be period=(( |multi_in|(`tags`, array('default'))
rule
yes
set (PDF)
|*| |!multi_in|(àntitags`, array('default'))))
Return
<liverailapi requested="/order/line/targeting/set" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/targeting/delete

Method Description
Delete a rule for an owned order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
Parent rule id
string or rule id if parent_rule_id=7533
parent_rule_id yes
you own the
line.
The
order_line_id no
of the order
line
Return
<liverailapi requested="/order/line/targeting/delete" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
MARKETPLACE TARGETING
These are the methods related to marketplace targeting

/order/line/marketplace/targeting/set
/order/line/marketplace/targeting/list
/order/line/marketplace/targeting/delete
Method Name: /order/line/marketplace/targeting/list

Method Description
Get all rules for an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
order_line_id yes
of the order
line.
Return
<liverailapi requested="/order/line/marketplace/targeting/list" api_version="X.Y.Z">
<rules>
<rule>
<marketplace_rule_id>The numerical ID of the marketplace rule</marketplace_rule_id>
<order_line_id>The numerical ID of the order line.</order_line_id>
<entity_id>The numerical ID of the entity</entity_id>
<rule>The marketplace's rule</rule>
</rule>
</rules>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/marketplace/targeting/set

Method Description
Set the targeting rule for a marketplace.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string
order_line_id yes
order_line_id=987365
of the order
line.
The
string numerical ID entity_id=554
entity_id
yes
of the entity.
string The rule to be period=(( |multi_in|(`tags`, array('default'))
rule
yes
set (PDF)
|*| |!multi_in|(àntitags`, array('default'))))
Return
<liverailapi requested="/order/line/marketplace/targeting/set" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/marketplace/targeting/delete

Method Description
Remove a marketplace targeting rule from an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of
order_line_id
string from which order_line_id=554841
order_line_id yes
the
marketplace
targeting is
deleted.
Optionally,
the numerical
string
entity_id
no
entity_id=866
ID of the
publisher.
Return
<liverailapi requested="/order/line/marketplace/targeting/delete" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
FREQUENCY CAPPING
These are the methods related to frequency capping

/order/line/frequency/set
/order/line/frequency/list
/order/line/frequency/delete
Method Name: /order/line/frequency/list

Method Description
Return the frequency cappings for an order line.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string of the order order_line_id=o987365
order_line_id yes
line for which
the cappings
will be listed.
Specify
whether to
return only
set the inherited only_inherited=1
only_inherited no
data or not.
The accepted
values are: 0
and 1
Return
<liverailapi requested="/order/line/frequency/list" api_version="X.Y.Z">
<cappings>
<capping>
<order_line_id></order_line_id>
<period></period>
<total></total>
<inherited>1|0</inherited>
</capping>
...
</cappings>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/frequency/set

Method Description
Set an order line frequency capping.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string of the order order_line_id=o987365
order_line_id yes
line for which
the capping is
modified.
integer The period in period=3600
period
yes
seconds
The maximum
number of
integer impressions total=10
total
yes
for the
specified
period.
Return
<liverailapi requested="/order/line/frequency/set" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/frequency/delete

Method Description
Remove an order line frequency capping.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the order
string line from
order_line_id yes
which the
capping is
removed.
integer The period in period=3600
period
no
seconds
Return
<liverailapi requested="/order/line/frequency/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
PARTNERS
All the methods related to partners are displayed here.

Partners
These are the methods used to handle Partners
/partner/available
/partner/add
/partner/edit
/partner/list
/partner/delete
/partner/resolve/name
/partner/resolve/id
Revenue Share
/revenue-share/add
/revenue-share/edit
/revenue-share/list
/revenue-share/delete
Method Name: /method/name/here

Method Description
This is the method's template. Please provide a full description of this method.
Related Methods
Related methods go in here.
this is a test link
Parameters
Name
sample sample
Required
yes
sample example
parameter
type overview
Authentication
token
yes
(received
after /login).
sample sample
Optional
no
sample example
parameter
type overview
Return
<connections>
<connection>
</connection>
...
<connections>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
bla bla 1
bla bla 1
Description
bla bla 2
bla bla 2
Reason
bla bla 2
bla bla 2
Method Name: /partner/available

Method Description
Verify the number of available partners remaining for this entity.
Parameters
Example
Authentication
token yes
(received after
/login).
Specify the
Entity ID. This
parameter is
optional, and if
string it is not given, entity_id=9876
entity_id no
the information
will be
returned for
the current
entity.
Return
<liverailapi requested="/partner/available" api_version="X.Y.Z">
<available>The available partners number remaining for the entity.</available>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /partner/list

Method Description
List all the available partners.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID of
the entity(es) for
which the partner
integer information will be entity_id=8866,5534
entity_id no
returned. Multiple
IDs can be bind
together by "|" or
","
The numeric ID(s)
of the partner(s)
integer to be listed.
partner_id no
partner_id=844,654
Multiple IDs can
be bind together
by "|" or ","
The name of the
string partner to be
name
no
name=FishBowl
listed.
Return only the
partners with the
string name that are
like_name no
like_name=Fish
LIKE
%search_string%.
Return
<liverailapi requested="/partner/list" api_version="X.Y.Z">
<partners>
<partner>
<partner_id>the numeric ID of the partner</partner_id>
<entity_id>the numeric ID of the entity</entity_id>
<name>the name of the partner</name>
</partner>
....
</partners>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /partner/resolve/name

Method Description
Resolve a numeric partner(s) ID to its name.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
partner for
which the
integer name will be partner_id=886453
partner_id yes
returned.
Separate
multiple
values with
comma (,).
Return
<liverailapi requested="/partner/resolve/name" api_version="X.Y.Z">
<partners>
<partner>
<partner_id>The numeric ID of the partner</partner_id>
<name>The name of the partner</name>
</partner>
...
</partners>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /partner/add

Method Description
Add a new partner.
Parameters
Example
Authentication
token yes
(received after
/login).
string The name of the name=testpart
name yes
partner to add.
Return
<liverailapi requested="/partner/add" api_version="X.Y.Z">
<partner_id>the numeric ID for the new added partner</partner_id>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /partner/edit

Method Description
Edit an existing partner.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
integer ID of the
partner_id yes
partner_id=886643
partner to be
edited.
The new
string name of the name=testpart22
name
yes
partner.
Return
<liverailapi requested="/partner/edit" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /partner/delete

Method Description
Delete an existing partner.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
partner to be
integer deleted.
partner_id yes
partner_id=886643
Multiple IDs
can be bind
together by "|"
or ","
Return
<liverailapi requested="/partner/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
REVENUE SHARE
All the methods related to revenue shares are displayed here.

/revenue-share/add
/revenue-share/edit
/revenue-share/list
/revenue-share/delete
Method Name: /revenue-share/add

Method Description
Add the revenue share parameter for a given partner.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the partner
string for which you partner_id=6235
partner_id yes
want to add
the revenue
share
parameter.
The value of
float the partner's share=7.5
share
yes
share.
The type of
the partner's
share. The
accepted
values are:
"fixed" - a
fixed
set
type
yes
type=p-net
ammount , "pnet" percentage
from net, "pgross" percentage
from gross
The
numerical ID
of the entity
for which the
revenue
integer share
entity_id no
entity_id=8756
parameter will
be added. If
not given, it
will default to
the current
entity.
Return
<liverailapi requested="/revenue-share/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /revenue-share/edit

Method Description
Edit the revenue share parameter for a given partner.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the partner
string for which you partner_id=6235
partner_id yes
want to edit
the revenue
share
parameter.
The new
float value of the share=7.5
share
yes
partner's
share.
The new type
of the
partner's
share. The
accepted
values are:
"fixed" - a
set
type
yes
fixed
type=p-net
ammount , "pnet" percentage
from net, "pgross" percentage
from gross
The
numerical ID
of the entity
for which the
revenue
integer share
entity_id no
entity_id=8756
parameter will
be edited. If
not given, it
will default to
the current
entity.
Return
<liverailapi requested="/revenue-share/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /revenue-share/delete

Method Description
Delete the revenue share parameter for a given partner.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the partner
from which
string
partner_id yes
you want to partner_id=6235
remove the
revenue
share
parameter.
The
numerical ID
of the entity
from which
the revenue
integer share
entity_id no
entity_id=8756
parameter will
be deleted. If
not given, it
will default to
the current
entity.
Return
<liverailapi requested="/revenue-share/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
ADVERTISERS
All the methods related to advertisers are displayed here.

/advertiser/add
/advertiser/list
/advertiser/resolve/name
/advertiser/resolve/name/from/creative
Method Name: /advertiser/list

Method Description
Get the list of advertiser(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
The
advertiser
ID(s). If you
have multiple
string ID(s) you can advertiser_id = 1|7|120 or advertiser_id =
advertiser_id no
make a single 1,7,120
call by
glueing them
together with
| or ,
The ID of the
entity for
which you
want to get
the list of
advertisers.
This
integer parameter is entity_id=545
entity_id
no
optional. If not
given, this
parameter will
automatically
get the value
of the current
entity.
Return
<liverailapi requested="/advertiser/list" api_version="X.Y.Z">
<advertisers>
<advertiser>
<advertiser_id>The ID of the advertiser</advertiser_id>
<name>The name of the advertiser</name>
</advertiser>
...
</advertisers>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /advertiser/add

Method Description
Add an advertiser.
Parameters
Authentication
token yes
(received
after /login).
string The name of name=test123
name yes
the advertiser.
The ID of the
entity for
which you
want to add
the advertiser.
integer If not given, entity_id=545
entity_id no
this
parameter will
automatically
get the value
of the current
entity.
Return
<liverailapi requested="/advertiser/add" api_version="X.Y.Z">
<advertiser_id>The ID of the newly added advertiser</advertiser_id>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /advertiser/resolve/name

Method Description
Returns the values for a list of advertiser ID(s). This method should be used when
dimension[1,2,3] from statistics was advertiser_id and you need to know the actual
advertiser name for the retrieved ID(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
The
advertiser
ID(s). If you
have multiple
integer ID(s) you can advertiser_id = 1|7|120 or advertiser_id =
advertiser_id yes
call by
glueing them
together with
| or ,
Return
<liverailapi requested="/advertiser/resolve/name" api_version="X.Y.Z">
<advertisers>
<advertiser>
<advertiser_id>The ID of the advertiser</advertiser_id>
<entity_id>The ID of the entity</entity_id>
<name>The name of the advertiser</name>
</advertiser>
...
</advertisers>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /advertiser/resolve/name/from/creative

Method Description
Resolves the advertiser names from a list of creative IDs.
Parameters
Name

Authentication
token
yes
(received
after /login).
The creative
ID(s). If you
have multiple
ID(s) you can
integer make a single creative_id = 1|7|120 or creative_id =
creative_id yes
1,7,120
call by
glueing them
together with
| or ,
The
advertiser
ID(s). If you
have multiple
integer ID(s) you can advertiser_id = 1|7|120 or advertiser_id =
advertiser_id no
call by
glueing them
together with
| or ,
Return
<liverailapi requested="/advertiser/resolve/name/from/creative" api_version="X.Y.Z">
<advertisers>
<advertiser>
<creative_id>The ID of the creative</creative_id>
<name>The name of the advertising</name>
</advertiser>
...
</advertisers>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
30 August 2012
14 November 2012
Description
Method added into chm.
Added advertiser_id
Reason
Align with API
Align with API
ADVERTISING CATEGORIES
All the methods related to advertiser categories are displayed here.

/advertising/category/list
/advertising/category/creative/list
/advertising/category/resolve/name
/advertising/category/resolve/name/from/creative
Method Name: /advertising/category/list

Method Description
List all the available advertising categories.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID of
the advertising
category for
which the
information will be
integer returned. If you advertising_category_id = 1|7|120 or
advertising_category_id
no
advertising_category_id = 1,7,120
have multiple id(s)
you can make a
single call by
glueing them
Search based on
string the advertising advertising_category_name = Test
advertising_category_name no
category full
category
name.
Limit the number
limit
no
limit=50
pagination(s).
The offset from
where the limit
should be applied
( if you display 10
results per page
and you need to
integer get the 3rd page offset=5
offset
no
you should set
offset to 20 and
limit to 10 ). Do
not use without
specifying the
limit parameter as
well.
Return only
advertising
string categorys with the search_string=test
search_string
no
name that are
LIKE
%search_string%.
Return
<liverailapi requested="/advertising/category/list" api_version="X.Y.Z">
<list>
<advertising_category_id>The numeric ID of the advertising category</advertising_category_id>
<advertising_category_name>string: the advertising category name</advertising_category_name>
...
</list>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
31 July 2012
Description
Reason
Align with API
Method Name: /advertising/category/list

Method Description
List all the available advertising categories.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
advertising
category
ID(s). If you
have multiple
integer ID(s) you can advertising_category_id = 1|7|120 or
advertising_category_id = 1,7,120
make a single
call by
glueing them
together with
| or ,
Return
<liverailapi requested="/advertising/category/creative/list" api_version="X.Y.Z">
<advertising_category_id>The numeric ID of the advertising category.</advertising_category_id>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
31 July 2012
Description
Reason
Align with API
CONNECTIONS
All the methods related to connections are displayed here.

Connections
These are the methods used to handle connections
/connection/add
/connection/edit
/connection/list
/connection/delete
/connection/resolve/name
/connection/set/archived
Connections Trackers
/connection/tracker/add
/connection/tracker/edit
/connection/tracker/list
/connection/tracker/delete
Method Name: /connection/list

Method Description
List the available connections.
Parameters
Name

Example
Authentication
yes
(received after
/login).
Flag that controls
if the "My
Campaigns"
connection ( the
connection
between an entity
integer and itself ) should including_myself=1
including_myself yes
be returned or
not. Set it to 1 to
return this
connection or set
it to 0 to hide this
connection. The
default value is 0.
Flag that controls
if the LiveRail
Central
connections
should be
integer returned or not. including_exchange=1
including_exchange yes
Set it to 1 to
return these
connection or set
it to 0 to hide
them. The default
value is 0.
The order by
criteria. The
supported values
are network,
string publisher,
order_by
no
order_by=network
connection,
connection_id. It
defaults to
connection_id.
Filter the
connections
based on the
management
status. The
enum supported values managed=yes
managed
no
are: yes ( the
connection is
managed ) and no
( the connection
is direct ).
Filter the
connections
based on the
direction. The
supported values
string are: INCOMING ( direction=OUTGOING
direction
no
the current entity
token
enabled_publisher no
enabled_network
no
connection_id
no
entity_id
no
entity_filter
no
hide_archived
no
search_string
no
acts as publisher
) and OUTGOING
( the current entity
acts as a network
).
Return only the
connections that
are have this
specific flag value
integer ( 0 ( the
enabled_publisher=1
connection is
disabled ) and 1 (
the connection is
enabled ) ).
Return only the
connections that
are have this
specific flag value
( -1 ( the
integer connection is
enabled_network=1
refused ), 0 ( the
connection is
disabled ) and 1 (
the connection is
enabled ) ).
Return only the
connections that
match the given
ID(s). If you have
integer multiple ID(s) you connection_id = 1|7|120 or connection_id
= 1,7,120
can make a single
call by gluing
them together
with | or ,
The ID of the
entity for which
the connections
integer are returned. If entity_id=123
not given, it will
default to the
current entity.
The ID of the
entity for which
the connection(s)
with the entity_id
integer are returned. If entity_filter = 1|7|120 or entity_filter =
you have multiple 1,7,120
ID(s) you can
make a single call
by gluing them
yes|no: The
default value is
enum "yes". If set to
hide_archived=no
"no", it will display
the archived
connections.
Return only the
network
organizations or
string connections with search_string=trala
the name that are
LIKE
%search_string%.
Return
<liverailapi requested="/connection/list" api_version="X.Y.Z">
<total>the number of connections</total>
<connections>
<connection>
<publisher_id>the id of the publisher entity</publisher_id>
<network_id>the id of the network entity</network_id>
<enabled_network>the network "enabled" flag</enabled_network>
<enabled_publisher>the publisher "enabled" flag</enabled_publisher>
<enabled_in>if the connection supports IN orders</enabled_in>
<enabled_ov>if the connection supports OV orders</enabled_ov>
<net_to_site_method>connection's method</net_to_site_method>
<net_to_site_value>the value</net_to_site_value>
<weight>Integer value between 0 and 50 (must be the Publisher in the connection to have this parameter displayed)</weight>
<parameters>the connection parameters</parameters>
<login_username>the login username ( this is not the username for a LiveRail account, but for the account you have on the networks site )</login_username>
<login_password>the login password ( this is not the password for a LiveRail account, but for the account you have on the networks site )</login_password>
<login_info>login info</login_info>
<via_connect>if the connection is done via LiveRail ( in which case it has a 1 value ) or not ( in which case it has a 0 value )</via_connect>
<performance_in>the connection performance for IN orders</performance_in>
<performance_ov>the connection performance for OV orders</performance_ov>
<name>the connection name</name>
<is_marketplace>"yes" | "no"</is_marketplace>
<bid_optimization>enabled | disabled </bid_optimization>
<managed>"yes" | "no"<managed>
<is_archived>"yes" | "no"<is_archived>
<archived_by></archived_by>
<daily_impression_cap>The daily impression cap. (must be the Publisher in the connection to have this parameter displayed).</daily_impression_cap>
<status>active | checking | completed</status>
<rtb_enabled>yes|no</rtb_enabled>
<buy_type></buy_type>
<network_organization>the organization name of the network</network_organization>
<network_description>the description of the network</network_description>
<network_perspective>the perspective of the network; P for Publisher, N for Network, A for Advertiser</network_perspective>
<publisher_organization>the organization name of the publisher</publisher_organization>
<publisher_description>the description of the publisher</publisher_description>
<publisher_perspective>the perspective of the publisher; P for Publisher, N for Network, A for Advertiser</publisher_perspective>
<network_is_parent_for_publisher>flag for tells you if the network is a direct parent for the publisher ( in which case it has a "yes" value ) or not ( in which case it has a "no" value )</network_is_parent_for_publisher>
<network_type>The network type.</network_type>
<is_exchange>flag for tells you if this connection is with LRC ( in which case it has a "yes" value ) or not ( in which case it has a "no" value )</is_exchange>
<gross_rate>the cost</gross_rate>
<impression>The impression count for the connection.</impression>
</connection>
...
</connections>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
28 May 2012
10 August 2012
10 September 2012
08 January 2013
Description
Added bid_optimization
Added managed
Added hide_archived
Added rtb_enabled, buy_type, network_type
Reason
Align with API
Align with API
Align with API
Align with API
Method Name: /connection/resolve/name

Method Description
Returns the values for a list of advertiser id(s). This method should be used when
dimension[1,2,3] from statistics was connection_id and you need to know the
actual connection names for the retrieved id(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
Return only
the
connections
that match the
given id(s). If
connection_id = 1|7|120 or connection_id
integer you have
connection_id yes
multiple id(s) = 1,7,120
you can make
a single call
by glueing
them together
with | or ,
Return
<connections>
<connection>
</connection>
...
<connections>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /connection/add

Method Description
Adds a new connection between two entities, where one acts as a network and
the other one as a publisher.
Parameters
Name

Example
yes
The numerical ID of the entity to
integer which the current entity should be entity_id=123
entity_id
yes
connected.
The direction of the connection.
The supported values are:
INCOMING ( the current entity
string acts as publisher and the given direction=OUTGOING
direction
yes
entity_id will be its network ) and
OUTGOING ( the current entity
acts as a network for the given
entity_id ).
name
yes
string The name of the connection
name=conn1
When the connection is
"is_marketplace", specify the
status of the bid optimization for
enum the entity. The accepted values bid_optimization=enabled
bid_optimization
no
are "enabled" and "disabled", with
the default value being
"disabled".
Specify if the connection is done
via LiveRail ( in which case
string should have value "1" ) or not ( in via_connect=0
via_connect
no
which case should have value "0"
)
gross_rate
no
float The cost of the connection.
gross_rate=5.2
string Accepted values are: "custom", net_to_site_method=custom
net_to_site_method no
"site", "gross".
When
net_to_site_method=custom, the
connection value is specified by
float the user. Otherwise,
net_to_site_value
no
net_to_site_value=7.5
net_to_site_method=site, the
connection value is the site's flat
rate.
If the connection supports IN
orders. The supported values
enum are: 0 ( IN orders are not
enabled_in
no
enabled_in=1
supported ) and 1 ( IN orders are
supported ). If not given, it
defaults to 1.
If the connection supports OV
orders. The supported values
enum are: 0 ( OV orders are not
enabled_ov
no
enabled_ov=1
supported ) and 1 ( OV orders
are supported ). If not given, it
defaults to 1.
Specify if the connection is
managed by LiveRail or not. The
supported values are: "yes"
enum (connection is managed by LR) managed=yes
managed
no
and "no". The default value is
"no". This parameter can only be
used by root-entities.
The connection parameters. The
parameters should be given as a
GET string. The network
string
parameters
no
parameters can be retrieved by DESCRIPTION=my%20description&MY_PARAMETER_1=value1&MY_PARAMETER_2=value2
using the
call.
Specify the connection weight.
integer Accepted values: integer
weight
no
weight=22
between 0 and 50.
daily_impression_cap no
integer Specify the daily impression cap. daily_impression_cap=25
The login username for the
string account created on the networks login_username=test
login_username
no
platform.
The login password for the
string account created on the networks login_password=ggg
login_passwordt
no
platform.
login_info
no
string The login info
login_info=the desired info
Control the Real Time Bidding.
The accepted values are "yes"
and "no". The default value
enum matches that of the entity's. If not rtb_enabled=no
rtb_enabled
no
given, the parameter value is not
parameter is available only to the
root users.
token
buy_type
no
Specify the buy type. The

enum accepted values are "rtb" and
"fixed". The default value is
"fixed".
buy_type=rtb
Return
<liverailapi requested="/connection/add" api_version="X.Y.Z">
<connection_id>the id of the newly added connection</connection_id>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
28 May 2012
10 August 2012
08 January 2013
Description
Added managed
Added rtb_enabled, buy_type
Reason
Align with API
Align with API
Align with API
Method Name: /connection/edit

Method Description
Edit a connection between two entities.
Parameters
Name

Example
yes
The
numerical
ID
of
the
connection
to
integer
connection_id
yes
connection_id=123
be edited.
name
no
string The new name of the connection
name=conn2
When the connection is
"is_marketplace", specify the status
of the bid optimization for the entity.
enum The accepted values are "enabled" bid_optimization=enabled
bid_optimization
no
and "disabled". This parameter is
optional, meaning that, if not given,
the parameter value is not altered in
any way.
gross_rate
no
float The cost of the connection.
gross_rate=5.2
string Accepted values are: "custom", "site", net_to_site_method=custom
net_to_site_method no
"gross".
token
net_to_site_value
no
enabled_in
no
enabled_ov
no
managed
no
parameters
no
weight
no
daily_impression_cap no
login_username
no
login_password
no
login_info
no
enabled_publisher
no
enabled_network
no
rtb_enabled
no
buy_type
no
When net_to_site_method=custom,
the connection value is specified by
the user. Otherwise,
net_to_site_value=7.5
net_to_site_method=site, the
connection value is the site's flat rate.
If the connection supports IN orders.
The supported values are: 0 ( IN
orders are not supported ) and 1 ( IN
enum orders are supported ). This
enabled_in=1
parameter is optional, meaning that, if
not given, the parameter value is not
altered in any way.
If the connection supports OV orders.
The supported values are: 0 ( OV
orders are not supported ) and 1 ( OV
enum orders are supported ). This
enabled_ov=1
altered in any way.
Specify if the connection is managed
by LiveRail or not. The supported
values are: "yes" (connection is
enum managed by LR) and "no". This
managed=yes
altered in any way. This parameter
can only be used by root-entities.
The connection parameters. The
parameters should be given as a
GET string. The network parameters
string can be retrieved by using the
DESCRIPTION=my%20description&MY_PARAMETER_1=value1&MY_PARAMETER_2=value2
call. If "LR_API_NULL" is used, the
parameter will be cleared.
Specify the connection weight.
integer Accepted values: integer between 0 weight=22
and 50.
integer Specify the daily impression cap.
daily_impression_cap=25
string The login username for the account login_username=test
created on the networks platform.
string The login password for the account login_password=ggg
created on the networks platform.
float
string The login info

login_info=the desired info
If the connection is enabled on the
publisher's side. The supported
enum values are: 0 ( the connection is
enabled_publisher=1
disabled ) and 1 ( the connection is
enabled ). Only the entity acting as a
publisher can modify this flag.
If the connection is enabled on the
network's side. The supported values
enum are: 0 ( the connection is disabled ) enabled_network=1
and 1 ( the connection is enabled ).
Only the entity acting as a network
can modify this flag.
Control the Real Time Bidding. The
accepted values are "yes" and "no".
The default value matches that of the
enum entity's. If not given, the parameter rtb_enabled=no
value is not altered in any way. This
parameter is available only to the root
users.
Change the buy type (the change is
allowed only if "rtb_enabled=yes").
The accepted values are "rtb" and
enum "fixed". This parameter is optional, buy_type=rtb
parameter value is not altered in any
way.
Return
<liverailapi requested="/connection/edit" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
28 May 2012
10 August 2012
08 January 2013
Description
Added managed
Added rtb_enabled, buy_type
Reason
Align with API
Align with API
Align with API
Method Name: /connection/delete

Method Description
Delete a connection between two entities.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
integer of the
connection_id yes
connection_id = 120
connection to
be deleted.
Return
<liverailapi requested="/connection/delete" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /order/line/set/status

Method Description
Set/unset a conection as archived.
Parameters
Name

Authentication
token
yes
(received
after /login).
Specify the
numeric ID of
integer the
connection_id yes
connection_id=4564
connection to
be set/unset
as archived.
Specify if the
connection is
archived or
not. The
supported
values are:
yes ( the
connection is
enum archived )
is_archived yes
is_archived=yes
and no ( the
connection is
not archived
). Only the
entity acting
as a publisher
can modify
this flag.
Return
<liverailapi requested="/connection/set/archived" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
<warnings>
<warning>
<message>The reason why the status can't be changed for a publisher.</message>
<code></code>
</warning>
<warning>
<message>If the connection status changed successful, the reason why the connection is still not archived.</message>
<code></code>
</warning>
...
</warnings>
...
</liverailapi>
Change History
Date
20 August 2012
Description
Method added in chm
Reason
Align with API.
CONNECTION TRACKERS
All the methods related to connection trackers are displayed here.

/connection/tracker/add
/connection/tracker/edit
/connection/tracker/list
/connection/tracker/delete
Method Name: /connection/tracker/list

Method Description
List the trackers associated with a connection.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer connection for connection_id=876
connection_id
no
which the
trackers will
be listed.
The numeric
integer ID of the
connection_tracker_id no
connection_tracker_id=8
tracker that
will be listed.
Return
<liverailapi requested="/connection/tracker/list" api_version="X.Y.Z">
<connection>
<trackers>
<tracker>
<connection_tracker_id>the numeric ID of the tracker</connection_tracker_id>
<connection_id>the numeric ID of the connection</connection_id>
</tracker>
...
</trackers>
</connection>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /connection/tracker/add

Method Description
Add a tracker to a connection. The unicity of a tracker is determined by the tuple
(connection_id, event, url) thus you can have multiple trackers for the same
connection and for the same event but with different URLs.
Parameters
Name

Example
token
yes
/login).
integer connection to which connection_id=876
connection_id yes
the tracker will be
added.
The tracker event:
impression impression, accept accept invitation,
quartile (25%
watched), view100 string complete view (100% event=view75
event
yes
- minimize overlay,
close - close,
- companion
events that can be
send from player
string The URL of the
url
yes
url=www.test.com
tracker.
Return
<liverailapi requested="/connection/tracker/add" api_version="X.Y.Z">
<connection_tracker_id>the numeric ID of the new tracker</connection_tracker_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
11 July 2012
11 September 2012
Description
Reason
Align with API
Align with API
Method Name: /connection/tracker/edit

Method Description
Edit a tracker for a connection. The unicity of a tracker is determined by the tuple
(connection_id, event, url) thus you can have multiple trackers for the same
connection and for the same event but with different URLs.
Parameters
Name

Example
token
yes
/login).
integer The numeric ID of the connection_tracker_id=8
connection_tracker_id yes
tracker to be edited.
The new tracker
event: impression impression, accept accept invitation,
quartile (25%
watched), view100 string complete view (100% event=complete
event
no
- minimize overlay,
close - close,
- companion
events that can be
send from player
string The new URL of the url=www.test1.com
url
no
tracker.
Return
<liverailapi requested="/connection/tracker/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
11 July 2012
11 September 2012

Align with API

Align with API
Method Name: /connection/tracker/list

Method Description
List the trackers associated with a connection. At least one parameter must be
specified.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
connection
whose
trackers will
integer be deleted. If connection_id=876
connection_id
no
specified, all
the trackers
attached to
conection_id
will be
deleted.
The numeric
ID of the
tracker to be
integer deleted.
connection_tracker_id no
connection_tracker_id=8
Specify if you
want to delete
a certain
tracker.
The event
type of the
trackers to be
deleted. If
integer specified, all event=complete
event
no
the trackers
having the
specified
event will be
deleted.
Return
<liverailapi requested="/connection/tracker/delete" api_version="x.y.z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
PRICE FLOOR
All the methods related to price floors are displayed here.

/site/settings/list
/site/settings/set
Method Name: /site/settings/list

Method Description
Returns the list of publisher ( site ) settings for the current entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The publisher
id(s) for which
we want to
retrieve the
settings. You
publisher_id = 1|7|120 or publisher_id =
integer can send
publisher_id no
1,7,120
multiple id(s)
by glueing
them together
with "|" or with
","
Return
<liverailapi requested="/site/settings/list" api_version="X.Y.Z">
<site_settings>
<site_setting>
<network_id>the id of the current entity</network_id>
<publisher_id>the id of the publisher entity</publisher_id>
<cost_cpc>the cpc cost</cost_cpc>
<cost_cpm>the cpm cost</cost_cpm>
<percentage>the percentage</percentage>
<publisher_name>the organization name of the publisher</publisher_name>
</site_setting>
...
</site_settings>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /site/settings/set

Method Description
Sets the site ( publisher ) settings for the current entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The publisher
id(s) for which
we want to
retrieve the
settings. You
publisher_id = 1|7|120 or publisher_id =
integer can send
publisher_id yes
1,7,120
multiple id(s)
by glueing
them together
with "|" or with
","
The default
float CPM cost for cost_cpm=8.65
cost_cpm no
the given
publisher.
The default
float CPC cost for cost_cpc=4.65
cost_cpc no
the given
publisher.
The
integer percentage percent=50
percent
no
applied to the
gross rate.
Return
<liverailapi requested="/site/settings/list" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
PRICING FLOOR RULES
All the methods related to pricing floor rules are displayed here.
/pricing/floor/rule/add
/pricing/floor/rule/edit
/pricing/floor/rule/list
/pricing/floor/rule/delete
Method Name: /pricing/floor/rule/add

Method Description
Add a pricing floor rule.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
string The name of name=testrule
name
yes
the pricing rule.
The type(s) for
which the rule
apply. Possible
values:
set ov|pre|mid|post. set=ov,pre
apply
yes
You can send
multiple id(s) by
glueing them
together with |
or with ,
Boolean Logic
rule=rule=(( |multi_in|(`tags`,
string Specs for
rule
yes
array('default')) |*| |!multi_in|(àntitags`,
further details.
array('default'))))
(PDF)
The amount
specified for the
float pricing rule.
floor
yes
floor=4.3
Does not allow
more than 2
decimals.
Specify if the
pricing rule is
default or not.
enum The possible is_default=yes
is_default no
values are "0" |
"1". The default
value is "0".
Specify if the
pricing rule is
disabled or not.
enum The possible is_disabled
is_disabled no
values are "0" |
"1". The default
value is "0".
Return
<liverailapi requested="/pricing/floor/rule/add" api_version="X.Y.Z">
<pricing_rule_id>the id of the newly created pricing rule.</pricing_rule_id>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /pricing/floor/rule/edit

Method Description
Edit a pricing floor rule.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID
string of the rule to be name=testrule
pricing_rule_id yes
edited.
string The new name name=testrule
name
no
of the rule.
The type(s) for
which the rule
apply. Possible
values:
set ov|pre|mid|post. set=ov,pre
apply
no
You can send
multiple id(s) by
glueing them
together with |
or with ,
Boolean Logic
rule=rule=(( |multi_in|(`tags`,
string Specs for
rule
no
further details.
array('default'))))
(PDF)
The amount
specified for the
float pricing rule.
floor
no
floor=4.3
Does not allow
more than 2
decimals.
Specify if the
pricing rule is
default or not.
enum The possible is_default=yes
is_default
no
values are "0" |
"1". The default
value is "0".
Specify if the
pricing rule is
disabled or not.
enum The possible is_disabled
is_disabled no
values are "0" |
"1". The default
value is "0".
Return
<liverailapi requested="/pricing/floor/rule/edit" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /pricing/floor/rule/list

Method Description
List the pricing floor rules.
Parameters
Name

Authentication
token
yes
(received
after /login).
Search based
on the
string numeric ID of pricing_rule_id=2223
pricing_rule_id yes
the pricing
rule.
Limit the
number of
results for
string pagination(s). limit=20
limit
no
This
parameter is
optional.
Return
<liverailapi requested="/pricing/floor/rule/list" api_version="X.Y.Z">
<pricing_rules>
<pricing_rule>
<pricing_rule_id>the numeric ID of the pricing rule</pricing_rule_id>
<entity_id>the current entity ID</entity_id>
<name>the rule name</name>
<apply>the rule's application</apply>
<position>the rule's position</position>
<rule>Boolean format</rule>
<floor>float value</floor>
<is_default>0 | 1 </is_default>
<is_disabled>0 | 1 </is_disabled>
<is_deleted>0 | 1 </is_deleted>
</pricing_rule>
...
</pricing_rules>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /pricing/floor/rule/delete

Method Description
Delete a pricing floor rule.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
string ID of the rule pricing_rule_id=6653
pricing_rule_id yes
to be deleted.
Return
<liverailapi requested="/pricing/floor/rule/delete" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
PUBLISHERS
All the methods related to Publishers are displayed here.

Tags
/publisher/tag/add
/publisher/tag/available
/publisher/tag/list
/publisher/tag/delete
Frequency
/publisher/frequency/add
/publisher/frequency/list
/publisher/frequency/delete
PUBLISHER TAGS
All the methods related to Publisher tags are listed here.

/publisher/tag/add
/publisher/tag/available
/publisher/tag/list
/publisher/tag/delete
Method Name: /publisher/tag/available

Method Description
Verify the number of available tags remaining for this publisher.
Parameters
Example
Authentication
token yes
(received after
/login).
int Optional, the entity_id=965
entity_id no
entity ID.
Return
<liverailapi requested="/publisher/tag/available" api_version="x.y.z">
<available>The available tags number remaining for the publisher.</available>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /publisher/tag/list

Method Description
Return the tag list for an entity.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numerical ID
of the entity for
which the tags will
integer be returned. If not entity_id=8756
entity_id
no
given, it will
default to the
current entity.
The tag that
string should be
tag
no
tag=music
returned.
Return only tags
string with the name
search_string no
search_string=mus
that are LIKE
%search_string%.
integer Limit the number limit=5
limit
no
of results.
Return
<liverailapi requested="/publisher/tag/list" api_version="X.Y.Z">
<tags>
<tag>the tag</tag>
...
<tags>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
31 July 2012
Description
Added 2 new parameters
Reason
Align with API
Method Name: /publisher/tag/add

Method Description
Adds a publisher tag entry.
Parameters
Example
Authentication
token yes
(received after
/login).
The tag that
string should be added tag=music
tag yes
for the current
entity.
Return
<liverailapi requested="/publisher/tag/add" api_version="X.Y.Z">
<tag_name>The exact tag that was added in the database. If the tag name contains illegal characters, will be sanitized and causing the name to be displayed differently from the value initially sent. </tag_name>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /publisher/tag/delete

Method Description
Delete a publisher tag.
Parameters
Authentication
token yes
(received after
/login).
The tag that
string should be
tag yes
deleted
Example
tag=music
Return
<liverailapi requested="/publisher/tag/delete" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
PUBLISHER FREQUENCY
All the methods related to Publisher frequency are listed here.

/publisher/frequency/add
/publisher/frequency/list
/publisher/frequency/delete
Method Name: /publisher/frequency/list

Method Description
Lists the frequency cappings.
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/publisher/frequency/list" api_version="X.Y.Z">
<frequency>
<capping>
<type>the type</type>
<interval>the interval ( in seconds )</interval>
<count>the capping</count>
<partner_id>the partner; if null, it's a global capping</partner_id>
<divider>Value in seconds</divider>
</capping>
...
</frequency>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
10 August 2012
Description
Added divider.
Reason
Align with API
Method Name: /publisher/frequency/add

Method Description
Adds a publisher frequency entry.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The type of the
order ( in or ov )
type
yes
type=ov
capping should
work.
The interval for
which the
capping is set ( it
should be given
integer in seconds - for interval=86400
interval yes
example: if you
want a 1 day
interval you
should send
86400 ).
The number of
impressions after
which the
integer delivery is
count
yes
count=2525
suspended until
the interval
passes.
The numerical ID
of the partner for
which this
integer
partner_id no
capping will
partber_id=7856
work. If not
speicfied, it is a
global capping.
This parameter is
be used only by
UI, while the
period will remain
integer listed in seconds. divider no
It can take the
following values:
1,60,3600,86400.
The default value
is null.
Return
<liverailapi requested="/publisher/frequency/add" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
10 August 2012
Description
Added divider.
Reason
Align with API
Method Name: /publisher/frequency/delete

Method Description
Delete a publisher frequency entry.
Parameters
Name

Authentication
token
yes
(received
after /login).
The type of
the order ( in
or ov ) for
which we
want to delete
string the capping. type=ov
type
yes
This
parameter
must be
specified if no
"interval" is
given.
The interval
for which we
want to delete
the capping (
it should be
given in
seconds - for
example: if
integer you want a 1 interval=86400
interval yes
day interval
you should
send 86400 ).
This
parameter
must be
specified if no
"interval" is
given.
The
numerical ID
of the partner
for which this
capping will
be deleted. If
integer not given, it partber_id=7856
partner_id no
will delete
only the
global
capping
matching the
given interval
and type.
Return
<liverailapi requested="/publisher/frequency/delete" api_version="X.Y.Z">
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
Description
Reason
ALLOCATION RULES
All the methods related to allocation rules are displayed here.

Allocation rules
/allocation/add
/allocation/edit
/allocation/list
/allocation/delete
/allocation/duplicate
Group
/allocation/group/add
/allocation/group/edit
/allocation/group/list
/allocation/group/delete
Source
/allocation/source/add
/allocation/source/edit
/allocation/source/list
/allocation/source/delete
Method Name: /allocation/list

Method Description
List the allocation rule(s).
Parameters
Name
token

Authentication
yes
(received
allocation_id no
limit
no
after /login).
The
numerical ID
of the
allocation to
string be listed.
allocation_id=6084,6085
Multiple IDs
can be bind
together by "|"
or ","
int The limit for limit=5
the results
Return
<liverailapi requested="/allocation/edit" api_version="X.Y.Z">
<allocation>
<rule>
<allocation_id>the id of the allocation</id>
<code>the code of the allocation</code>
<name>the name of the allocation</name>
<description>the description of the allocation</description>
<is_default> Return values: yes | no. The default allocation rule ( the one that is created when the user creates the entity )
has this flag set on yes. This particular allocation rule cannot be deleted.</is_default>
<position>The position of the allocation.</position>
<name>the name of the allocation</name>
<apply>ov|pre|mid|post</apply>
<targeting_rule>The boolean specification</targeting_rule>
<disabled>yes|no</disabled>
</rule>
...
</allocation>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
17 May 2012
Description
Edit XML response
Reason
Method Name: /allocation/add

Method Description
Add an allocation.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
string The name of name=test123
name
yes
the allocation
The type for
which the rule
string apply. Possible apply=pre
apply
yes
values:
ov|pre|mid|post.
Boolean Logic.
Consult the
targeting_rule=(( |multi_in|(`tags`,
string following
targeting_rule yes
document for
array('default'))))
further details.
(PDF)
string Description of description=your description
description no
the allocation.
Specify the
allocation
position
integer compared to the position=77
position
no
other
allocations of
the entity.
Return
<liverailapi requested="/allocation/add" api_version="X.Y.Z">
<allocation_id>The id of the newly added allocation</allocation_id>
....
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Change History
Date
07 June 2012
Description
Updated paramethers.
Reason
Method Name: /allocation/edit

Method Description
Edit an allocation.
Parameters
Each API call contains optuired and optional parameters. Here is an overview of the
parameters you can add to this particular API optuest, where optuired parameters are
written in orange:
Name
optuired Type Overview

Example
Authentication
token
yes
(received after
/login).
The numerical
string ID of the
allocation_id yes
allocation_id=6084
allocation to be
edited.
The type for
which the rule
string apply. Possible apply=pre
apply
no
values:
ov|pre|mid|post.
Boolean Logic.
Consult the
targeting_rule=(( |multi_in|(`tags`,
string following
targeting_rule no
document for
array('default'))))
further details.
(PDF)
string Description of description=your description
description no
the allocation.
Specify the
allocation
position
integer compared to the position=77
position
no
other
allocations of
the entity.
Specify the
allocation's
status. The
enum accepted values status=archived
status
no
are "active" |
"archived".
Default value is
"active".
Return
<liverailapi requested="/allocation/edit" api_version="X.Y.Z">
....
...
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
07 June 2012
Description
Updated paramethers.
Reason
Method Name: /allocation/delete

Method Description
Delete an allocation.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string of the
allocation_id yes
allocation_id=6084
allocation to
be deleted.
Return
<liverailapi requested="/allocation/delete" api_version="X.Y.Z">
....
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/duplicate

Method Description
Duplicates allocation.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
string of the
allocation_id yes
allocation_id=6084
allocation to
be duplicated.
Return
<liverailapi requested="/allocation/duplicate" api_version="X.Y.Z">
<allocation_id>The newly allocation ID created by duplication</allocation_id>
<user>...</user>
<auth>...</auth>
...
</liverailapi>
Change History
Date
17 May 2012
Description
Added method in the help file
Reason
Align with API
GROUPS
All the methods related to allocation groups are displayed here.

/allocation/group/add
/allocation/group/edit
/allocation/group/list
/allocation/group/delete
Method Name: /allocation/group/list

Method Description
List the allocation group(s).
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation_group_id no
allocation_group_id=47758
allocation
group.
The
int numerical ID allocation_id=6084
allocation_id
no
of the
allocation.
int The priority of priority=2
priority
no
the group.
Return
<liverailapi requested="/allocation/group/list" api_version="X.Y.Z">
<allocation_groups>
<group>
<group_id>The id of the allocation group.</group_id>
<allocation_id>The id of the allocation.</allocation_id>
<priority>Priority of the group.</group>
</group>
</allocation_groups>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/group/add

Method Description
Add an allocation group.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
allocation_id yes
of the
allocation.
int The priority of priority=1
priority
yes
the group.
Return
<liverailapi requested="/allocation/group/add" api_version="X.Y.Z">
<allocation_group_id>The id of the created allocation group</allocation_group_id>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/group/edit

Method Description
Edit an allocation group.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation_group_id yes
allocation
group.
The new
int priority of the priority=2
priority
yes
group.
Return
<liverailapi requested="/allocation/group/edit" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/group/delete

Method Description
Delete an allocation group.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation
group to be
deleted.
The
allocation_id
no
of the
allocation.
Return
<liverailapi requested="/allocation/group/delete" api_version="X.Y.Z">
....
...
</liverailapi>
Change History
Date
Description
Reason
SOURCE
All the methods related to allocation sources are displayed here.

/allocation/source/add
/allocation/source/edit
/allocation/source/list
/allocation/source/delete
Method Name: /allocation/source/list

Method Description
List the allocation sources.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation
group.
The
int numerical ID connection_id=11
connection_id
no
of the
connection.
Return
<liverailapi requested="/allocation/source/list" api_version="X.Y.Z">
<allocation_sources>
<source>
<allocation_group_id>The id of the allocation group.</allocation_group_id>
<connection_id>The id of the connection.</connection_id>
<name>Connection name.</name>
</source>
</allocation_sources>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/source/add

Method Description
Add an allocation source.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation
group.
The
connection_id
yes
of the
connection.
Return
<liverailapi requested="/allocation/source/add" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/source/edit

Method Description
Edits an allocation source, by updating the connection_id for the given
allocation_group_id / old_connection_id pair.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation
group.
The
int numerical ID old_connection_id=11
old_connection_id yes
of the old
connection.
The
int numerical ID new_connection_id=27
new_connection_id yes
of the new
connection.
Return
<liverailapi requested="/allocation/source/edit" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /allocation/source/delete

Method Description
Delete an allocation source.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
int of the
allocation
group.
The
connection_id
yes
of the
connection.
Return
<liverailapi requested="/allocation/source/delete" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
CUSTOM MACRO MANAGEMENT
All the methods related to custom macro management are displayed here.
/custom/macro/list
/custom/macro/add
/custom/macro/edit
/custom/macro/delete
/custom/macro/attach
/custom/macro/detach
/custom/macro/edit/attach
Method Name: /custom/macro/list

Method Description
List the existing macros.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
Returns the
specified
custom
integer macro(s).
custom_macro_id
no
custom_macro_id=44|45
Multiple IDs
can be glued
together by "|"
Returns only
the values set
for publishers
for the
specified
custom
macro(s).
Multiple IDs
can be glued
together by
"|". If a custom
macro doesn't
integer have any
target_custom_macro_id no
target_custom_macro_id=424|425
values for
publishers, it
will not be
returned. If a
custom macro
has values for
several
publishers,
one XML node
will be
returned for
each of these
values.
Returns only
the custom
macro(s)
owned by the
integer specified
entity_id
no
entity_id=5424|5425
publisher(s).
Multiple IDs
can be glued
together by
"|".
Returns only
the custom
string macro(s) with search_string=sample macro 2
search_string
no
matching
macro_names.
Return
<liverailapi requested="/custom/macro/list" api_version="X.Y.Z">
<custom_macros>
<custom_macro>
<custom_macro_id>the id of the custom macro</custom_macro_id>
<entity_id>the id of the entity for which it was created</entity_id>
<macro_name>the macro name</macro_name>
<comments>the comments for the macro</comments>
</custom_macro>
...
</custom_macros>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /custom/macro/add

Method Description
Adds a custom macro for an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
string The name for name=sample macro
macro_name yes
the macro.
Comments for
string the custom comments=to be used
comments no
macro, if any.
Return
<liverailapi requested="/custom/macro/add" api_version="X.Y.Z">
<custom_macro_id>the id of the newly added custom macro</custom_macro_id>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /custom/macro/edit

Method Description
Edit a custom macro for an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
integer
custom_macro_id yes
of the custom custom_macro_id=44
macro to be
edited.
The new
string
macro_name
no
name for the name=sample macro 2
macro.
string Edit the
comments
no
comments=to be used also
comments.
Return
<liverailapi requested="/custom/macro/edit" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /custom/macro/delete

Method Description
Delete a custom macro from an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
integer
custom_macro_id yes
of the custom custom_macro_id=44
macro to be
deleted.
Return
<liverailapi requested="/custom/macro/delete" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /custom/macro/attach

Method Description
Attaches the macro to an entity.
Parameters
Name

Authentication
session token
string
token
yes
(received
after /login).
The
numerical ID
integer of the custom custom_macro_id=44
custom_macro_id yes
macro to be
deleted.
The
numerical ID
of the
integer publisher
publisher_id
yes
publisher_id=7744
(entity) the
macro will be
attached to.
integer The value of macro_value=4
macro_value
yes
the macro
Return
<liverailapi requested="/custom/macro/attach" api_version="X.Y.Z">
<custom_macro_j_entity_id>id of the newly created attachment</custom_macro_j_entity_id>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /custom/macro/edit/atttach

Method Description
Edits a macro attchment value
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the custom
integer macro
custom_macro_j_entity_id yes
custom_macro_j_entity_id=77
attachement
to be
detached.
The new
integer value of the macro_value=5
macro_value
yes
macro.
Return
<liverailapi requested="/custom/macro/edit/attach" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /custom/macro/detach

Method Description
Detach a macro from an entity.
Parameters
Name

Authentication
token
yes
(received
after /login).
The
numerical ID
of the custom
integer macro
custom_macro_j_entity_id yes
custom_macro_j_entity_id=77
attachement
to be
detached.
Return
<liverailapi requested="/custom/macro/detach" api_version="X.Y.Z">
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
Description
Reason
LOCATION
All the methods relatod to location are listed here.

/location/list
Method Name: /location/list

Method Description
List all the available geographical locations.
Parameters
Name

Authentication
token
yes
(received
after /login).
Search based
string on the ID of location_id=AU_0_0_0
location_id no
the location.
Return a
search based
on a given
string string. the
search_string no
search_string=testing
search will
take place in
all
parameters.
Limit the
number of
results for
pagination(s).
integer This
limit
no
limit=50
parameter is
optional. The
default value
is 500.
The offset
from where
the limit
should be
applied ( if
you display
10 results per
page and you
need to get
the 3rd page
string you should offset=20
offset
no
set offset to
20 and limit to
10 ). This
parameter is
optional and
shouldn't be
given without
only_country no
giving the limit

parameter as
well.
Search within
and return
only the
country. The
enum accepted
only_country=yes
values are:
"yes", "no".
The default
value is "no".
Return
<liverailapi requested="/location/list" api_version="X.Y.Z">
<locations>
<list>
<location>
<location_id>location ID</location_id>
<country>location country or description</country>
<region>location available regions or null</region>
<metro>location available areas or null</metro>
<city>location available city or null</city>
</location>
...
</list>
<count>The total number of locations listed</count>
</locations>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
25 June 2012
Description
Added parameters.
Reason
Align with API.
STATISTICS
All the methods related to statistics and report generation are displayed here.
Statistics
/statistics
Reports Portfolio
/reports/portfolio/add
/reports/portfolio/edit
/reports/portfolio/list
/reports/portfolio/delete
Schedules
/reports/portfolio/schedule/add
/reports/portfolio/schedule/edit
/reports/portfolio/schedule/list
/reports/portfolio/schedule/delete
Method Name: /statistics

Method Description
Retrives statistics from the data warehouse.
Parameters
Name

Example
token
yes
/login).
The available
aggregations are: all (
counts the entries that
match the given criteria,
grouped by the given
dimension(s) ), unqiue (
counts the unique
entries that match the
given criteria, grouped
by the given dimensions
)
enum cost_advertiser_revenue aggregation=cost_publisher_revenue
aggregation no
( the amount of $ that an
entity has earned when
acting as an advertiser ),
cost_publisher_revenue
( the amount ot $ that an
entity has earned as a
publisher ),
cost_publisher_spending
( the amount of $ that an
entity should pay the
publishers that showed
its ads ). Defaults to 'all'.
The available
dimensions are: time
dimensions: hour ( Hour
), day ( Day ), week (
Week ), month ( Month ),
publisher_id ( Site ),
connection_id ( Ad
source ), partner_id (
Partner ),
creative_campaign_id (
Creative Group ),
creative_id ( Creative ),
category_id ( Category ),
segment_id (Segment),
location_country (
Country ), domain_name
( Domain ),
order_number_id ( Order
Number ), order_id (
Order ), order_line_id (
Order Line ), network_id
( Network ). For the
location_region (
State/Region ),
location_metro ( Metro
area ), location_city (
City ),
video_publisher_video (
Media ID ),
video_am_video (
string Fingerprint ID ),
dimension1 yes
...
dimension2 no
item_name ( Content tag

), browser_name (
Browser ), os_name (
Operating system ),
autoplay_id (autoplay ID
- 0 ( unknown ), 1 ( Click
to Play ), 2 ( Auto Play )),
muted_id (muted ID 0 (
unknown ), 1 ( Sound on
), 2 ( Sound off )),
playersize_id (playersize
ID 0 ( unknown ), 1 (
small ), 2 ( medium ), 3 (
large )),
content_type_name
(Content Type Name),
content_type_id
(Content Type ID),
autoplay_name
(Autoplay Name),
muted_name (Muted
Name), playersize_name
(Playersize Name),
zipcode (Zip Code).
These dimensions must
be used for a scheduled
report portfolio. You
need to specify
dimension1 in order to
get a result.
The available
connection_id ( Ad
Partner ),
Creative Group ),
location_country (
( Domain ),
location_region (
State/Region ),
City ),
string Media ID ),
...
video_am_video (
Fingerprint ID ),
), browser_name (
Operating system ),
dimension3 no
large )),
content_type_name
content_type_id
(Content Type ID),
autoplay_name
(Autoplay Name),
muted_name (Muted
(Playersize Name),
zipcode (Zip Code).
report portfolio.
The available
connection_id ( Ad
Partner ),
Creative Group ),
location_country (
( Domain ),
location_region (
State/Region ),
City ),
string Media ID ),
...
video_am_video (
Fingerprint ID ),
), browser_name (
Operating system ),
large )),
content_type_name
content_type_id
(Content Type ID),
autoplay_name
(Autoplay Name),
muted_name (Muted
(Playersize Name),
zipcode (Zip Code).
report portfolio.
dimension4 no
The available
connection_id ( Ad
Partner ),
Creative Group ),
location_country (
( Domain ),
location_region (
State/Region ),
City ),
string Media ID ),
...
video_am_video (
Fingerprint ID ),
), browser_name (
Operating system ),
large )),
content_type_name
content_type_id
(Content Type ID),
autoplay_name
(Autoplay Name),
muted_name (Muted
(Playersize Name),
zipcode (Zip Code).
report portfolio.
The available
connection_id ( Ad
Partner ),
Creative Group ),
location_country (
dimension5 no
dimension6 no
( Domain ),
location_region (
State/Region ),
City ),
string Media ID ),
...
video_am_video (
Fingerprint ID ),
), browser_name (
Operating system ),
large )),
content_type_name
content_type_id
(Content Type ID),
autoplay_name
(Autoplay Name),
muted_name (Muted
(Playersize Name),
zipcode (Zip Code).
report portfolio.
The available
connection_id ( Ad
Partner ),
Creative Group ),
location_country (
( Domain ),
location_region (
State/Region ),
City ),
string Media ID ),
...
video_am_video (
time_start yes
time_end
yes
Fingerprint ID ),
), browser_name (
Operating system ),
large )),
content_type_name
content_type_id
(Content Type ID),
autoplay_name
(Autoplay Name),
muted_name (Muted
(Playersize Name),
zipcode (Zip Code).
report portfolio.
he start time for the
report. It is given as a
string ( yyyy-mm-dd
hh:ii:ss ); if the "time"
component ( hh:ii:ss ) is
missing, it will be
automatically replaced
with 00:00:00. Examples:
string "2010-12-08" ( it is
...
automatically converted
to 2010-12-08 00:00:00
), "2010-12-08
23:59:59". If
filters[timezone] is not
specified, the system will
automatically use the
timezone for the current
user.
The end time for the
report. It is given as a
string ( yyyy-mm-dd
hh:ii:ss ); if the "time"
component ( hh:ii:ss ) is
missing, it will be
automatically replaced
with 00:00:00. Examples:
string "2010-12-08" ( it is
...
automatically converted
to 2010-12-08 00:00:00
), "2010-12-08
23:59:59". If
filters[timezone] is not
specified, the system will
automatically use the
timezone for the current
user.
An array containing statistic filters. The
available filters are: publisher_id ( Site ),
connection_id ( Ad source ), partner_id (
Partner ), creative_campaign_id ( Creative
Group ), creative_id ( Creative ),
category_id ( Category ), location_country (
Country ), domain_name ( Domain ),
order_number_id ( Order Number )
order_id ( Order ), order_line_id ( Order
filters
yes
Line ), network_id ( Network ), metric (

Metric ), position ( Position ), timezone (
Timezone ). If you need more advanced
filters such as location_region (
State/Region ), location_metro ( Metro area
), location_city ( City ),
video_publisher_video ( Media ID ),
video_am_video ( Fingerprint ID ),
item_name ( Content tag ), browser_name (
Browser ), browser_id ( Browser ID ),
os_name ( Operating system ), os_id (
Operating system ID ), autoplay_id
(autoplay ID - 0 ( unknown ), 1 ( Click to
Play ), 2 ( Auto Play )), muted_id (muted ID
0 ( unknown ), 1 ( Sound on ), 2 ( Sound
off )), playersize_id (playersize ID 0 (
unknown ), 1 ( small ), 2 ( medium ), 3 (
large )), content_type_name (Content Type
Name), content_type_id (Content Type ID),
autoplay_name (Autoplay Name),
muted_name (Muted Name),
playersize_name (Playersize Name),
zipcode (Zip Code).
If you want to give several possible values
for a filter, you can concatenate them using
the ## separator ( if you need to get all the
entries with position 1 or 0 send
string Accepts 2 types of data: filters[postion] = 1##0 )
Serialized Array | JSON.
The supported metrics are: slot,
impression, view25, view50, view75,
view100, clickthru, accept, pause, resume,
mute, unmute, minimize, maximize, close,
companion, conversion, uniqueadslot,
cclickthru, fullscreen, leaveFullscreen,
custom1, custom2, custom3, custom4,
custom5, custom6, custom8.
The supported positions are: in, ov, full, 1,
0, 50, 100 ( in = ( 0, 50, 100 ); ov = ( 1 );
full = ( 1, 0, 50, 100 ) ).
The supported browser_id / browser_name
are: 0 / Other, 10 / MSIE, 15 / MSIE, 16 /
MSIE, 17 / MSIE, 18 / MSIE, 20 / Firefox,
21 / Firefox, 22 / Firefox, 23 / Firefox, 30 /
Opera, 39 / Opera, 40 / Chrome, 41 /
Chrome, 42 / Chrome, 43 / Chrome, 50 /
Safari, 60 / Silk.
TThe supported os_id / os_name are: 0 /
Other, 10 / Windows Other, 11 / Windows
2000, 12 / Windows XP, 13 / Windows
2003, 14 / Windows Vista, 15 / Windows 7,
16 / Windows 8, 20 / Mac OS, 30 / Linux,
40 / SymbianOS, 50 / iOS iPhone/iPod, 51
/ iOS iPad, 60 / Windows Phone, 70 /
Android, 80 / Blackberry.
The supported content_type_name /
content_type_id are: Video / 6 , Game / 5 ,
Music / 4 , Application / 3 , Text / 2 , Other /
1 , Unknown\Undefined / 0
Limitations:
you cannot specify multiple "timezone"(s)
you cannot specify multiple "metric"(s)
if you need more extensive dimensions or
filters you have to created a scheduled
report portfolio
Return
<liverailapi requested="/statistics" api_version="X.Y.Z">
<report>
<row>
<dimension1>the value for dimensions1</dimension1>
<dimension2>the value for dimensions2 ( if dimension2 was given )</dimension2>

<data>a numeric value representing the requested aggregation</data>
</row>
...
</report>
<user>
...
</user>
<auth>
...
</auth>
...
</liverailapi>
Change History
Date
21 August 2012
14 September 2012
Description
Added Content Type
Removed Advertiser ID
Reason
Align with API
Align with API
REPORT PORTFOLIOS
All the methods related to report portfolios are displayed here.

/reports/portfolio/add
/reports/portfolio/edit
/reports/portfolio/list
/reports/portfolio/delete
Method Name: /reports/portfolio/add

Method Description
Add a new report to the report portfolio.
Parameters
Name
Required Type
token
yes
name
yes
description
yes
start_period_type yes
start
yes
end_period_type yes
end
yes
visibility
yes
last_update_time yes
root_report
yes
Overview
Example
Authentication
session token
string
(received after
/login).
Portfolio report
string
name=test
name
Portfolio report
string
description=music
description.
The type of the
report's start time
period. "fixed"
means that that
the start point of
the time period will
enum
be fixed and not start_period_type=fixed
modify over time.
"rolling" means
that the start point
of the time period
will increment
every day.
The start time of
DateTime the report's time start=2011-12-22 00:00:00
period.
The type of the
report's end time
period. "fixed"
means that that
the end point of
enum
be fixed and not end_period_type=rolling
modify over time.
"rolling" means
that the end point
of the time period
will increment
every day.
The end time of
string
the report's time end=2011-12-25 00:00:00
period.
The visibility of
the report. It
accepts 2 values:
"public" or
"private". If you
set this to private
only the user that
enum
visibility=public
created it can
access it. If it's
public all users
that can access
that entity can
access the report
portfolio.
DateTime The last update last_update_time=2011-12-25 00:00:00
time of the report.
Specify the type
of the report. The
accepted values
are:
enum
root_report=forecast-in
"normal"|"forecastin"|"forecast-ov".
The default value
is "normal".
A php serialized array containing (the
JSON object structure must be identical to
the array one): The dimensions array can
contain: dimension1, dimension2,
dimension3, dimension4, dimension5 and
dimension6. For the available values
please look at /statistics.
The filters array must contain: from_date (
the start date yyyy-mm-dd format, for
example 2009-11-01 ), from_time ( the start
time in hh:ii format, for example 23:59 ),
to_date( the end date yyyy-mm-dd format,
for example 2009-11-01 ), to_time ( the end
time in hh:ii format, for example 23:59 ).
Filters can also contain the following keys:
publisher_id ( Site ), connection_id ( Ad
source ), partner_id ( Partner ),
creative_campaign_id ( Creative Group ),
creative_id ( Creative ), advertiser_id (
Advertiser ), location_country ( Country ),
domain_name ( Domain ), order_id ( Order
), order_line_id ( Order Line ), network_id (
Network ), timezone ( Timezone ),
location_region ( State/Region ),
location_metro ( Metro area ), location_city
( City ), video_publisher_video ( Media ID ),
item_name ( Content tag ), browser_id (
Browser ID ), os_id ( Operating system ID ),
autoplay_id (autoplay ID - 0 ( unknown ), 1
( Click to Play ), 2 ( Auto Play )), muted_id
(muted ID 0 ( unknown ), 1 ( Sound on ), 2 (
Sound off )), playersize_id (playersize ID 0
( unknown ), 1 ( small ), 2 ( medium ), 3 (
zipcode (Zip Code). For each of this keys (
except for timezone ) you need to give an
array ( even if there's actually a single
value, for example if you want to apply a
filter for connection_id and you want a
single value ( 150 ), you still have to define
filters[connection_id] = array( 150 ) ).
The columns array must contain at least
one column. The available columns are:
accept-invite ( Accepts ), air ( Accept rate ),
c-clicks ( Companion Click-Through ), cimprs ( Companion Impressions ), clicks (
Click-thru's ), clicks-mid ( Click-thru's (mid)
), clicks-post ( Click-thru's (post) ), clickspre ( Click-thru's (pre) ), close-rate ( Close
rate ), closes ( Closes ), complete-rate (
Complete Rate ), ctr ( CTR ), ctrcompanion ( Companion CTR ), ctr-mid (
CTR (mid) ), ctr-post ( CTR (post) ), ctr-pre
( CTR (pre) ), custom1 ( Custom 1 ),
custom2 ( Custom 2 ), custom3 ( Custom 3
), custom4 ( Custom 4 ), custom5 ( Custom
5 ), custom6 ( Custom 6 ), custom7 (
Custom 7 ), custom8 ( Survey ), ecpm (
Revenue eCPM ), ecpm-for-publisher (
Spending eCPM ), imprs ( Impressions ),
imprs-mid ( Impressions (mid) ), imprs-post
( Impressions (post) ), imprs-pre (
Impressions (pre) ), in-clicks ( Click-thru's
(i) ), in-ctr ( CTR (i) ), in-ecpm ( Revenue
eCPM (i) ), in-ecpm-for-publisher (
Spending eCPM (i) ), in-imprs (
Impressions (i) ), in-revenue-advertiser (
Revenue (i) ), in-revenue-publisher (
Spending (i) ), min-rate ( Minimize Rate ),
minimizes ( Minimizes ), mute-rate ( Mute
Rate ), mutes ( Mutes ), ov-clicks ( Clickthru's (o) ), ov-ctr ( CTR (o) ), ov-ecpm (
Revenue eCPM (o) ), ov-ecpm-for-
report_definition yes
enum
publisher ( Spending eCPM (o) ), ov-imprs

( Impressions (o) ), ov-revenue-advertiser (
Accepts 2 types of Revenue (o) ), ov-revenue-publisher (
data: Serialized Spending (o) ), pause-rate ( Pause Rate ),
Array | JSON.
pauses ( Pauses ), revenue-advertiser (
Revenue ), revenue-publisher ( Spending ),
u-imprs ( Unique Impressions ), u-in-imprs (
Unique Impressions (i) ), u-ov-imprs (
Unique Impressions (o) ), video-ad-plays (
Ad Starts ), watched-100 ( Watched 100%
), watched-25 ( Watched 25% ), watched50 ( Watched 50% ), watched-75 (
Watched 75% ), inventory ( Inventory ),
inventory-in ( Inventory (i) ), inventory-ov (
Inventory (o) ), inventory-pre ( Inventory
(pre) ), inventory-mid ( Inventory (mid) ),
inventory-post ( Inventory (post) ),
inventory-fill ( Inventory Fill ), inventory-fillin ( Inventory Fill (i) ), inventory-fill-ov (
Inventory Fill (o) ), inventory-fill-pre (
Inventory Fill (pre) ), inventory-fill-mid (
Inventory Fill (mid) ), inventory-fill-post (
Inventory Fill (post) ), ad-requests ( Ad
Requests ), ad-requests-in ( Ad Requests
(i) ), ad-requests-ov ( Ad Requests (o) ),
ad-requests-pre ( Ad Requests (pre) ), adrequests-mid ( Ad Requests (mid) ), adrequests-post ( Ad Requests (post) ), adrequests-fill ( Ad Requests Fill ), adrequests-fill-in ( Ad Requests Fill (i) ), adrequests-fill-ov ( Ad Requests Fill (o) ), adrequests-fill-pre ( Ad Requests Fill (pre) ),
ad-requests-fill-mid ( Ad Requests Fill (mid)
), ad-requests-fill-post ( Ad Requests Fill
(post) ).
Safari, 60 / Silk.
The supported os_id / os_name are: 0 /
**If you have order_id and/or
order_line_id specified anywhere, the
following columns are not accepted:
"slots","in-slots","ov-slots","slots-pre","slotsmid","slots-post", "fill-rate-pre","fill-ratemid","fill-rate-post","fill-rate","slots-unique",
"in-slots-unique","ov-slots-unique","inrate","ov-rate","rate-unique", "in-rateunique","ov-rate-unique","ad-requests","adrequests-in", "ad-requests-ov","adrequests-pre","ad-requests-mid", "adrequests-post","inventory-1","inventory2","inventory","inventory-1-in", "inventory-2in","inventory-in","inventory-1ov","inventory-2-ov","inventory-ov",
"inventory-1-pre","inventory-2pre","inventory-pre","inventory-1-mid",
"inventory-2-mid","inventorymid","inventory-1-post","inventory-2-post",
"inventory-post","u-inventory-1","uinventory-2","u-inventory", "u-inventory-1in","u-inventory-2-in","u-inventory-in","uinventory-1-ov", "u-inventory-2-ov","uinventory-ov","u-inventory-1-pre","uinventory-2-pre", "u-inventory-pre","u-
inventory-1-mid","u-inventory-2-mid","uinventory-mid", "u-inventory-1-post","uinventory-2-post","u-inventorypost","inventory-fill", "inventory-fillin","inventory-fill-ov","inventory-fillpre","inventory-fill-mid", "inventory-fill-post".
Return
<liverailapi requested="/reports/portfolio/add" api_version="X.Y.Z">
<report_portfolio_id>the numeric ID of the report added to the portfolio</report_portfolio_id>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
21 August 2012
11 September 2012
Description
Added Content Type
Added non-valid parameters
Reason
Align with API
Align with API
Method Name: /reports/portfolio/list

Method Description
List the reports defined in the report portfolio.
Parameters
Name
token
entity_id

Example
Authentication
yes
(received after
no
report_portfolio_id no
limit
no
offset
no
/login).
Return only
the reports
owned by the
specified
entity(s). You
can send a
single ID or a
integer list of IDs by entity_id=735
glueing them
together with
"|". By default
the method
will return the
reports for the
current entity.
Return only
the reports
from the
specified
report profolio.
integer You can send report_portfolio_id=75
a single ID or
a list of IDs by
glueing them
together with
"|".
Limit the
integer number of
limit=24
records
returned.
Do not return
the first 'offset'
number of
string records (the offset=music
'limit'
status
no
set
running
no
set
output
no
set
canned_report
no
set
parameter
must be
specified).
Return only
the reports
that are
status=active
'active' or
'paused'.
Return only
the reports
that are
running=no
currently
running or not
running.
Return the
data in the
specified
format.
output=json
Possible
values are:
"array", "json"
Return the
portfolios that
are either
canned or not.
The portfolios
canned_report=yes
that have
canned_report
= yes cannot
be deleted or
edited.
Return
<liverailapi requested="/reports/portfolio/list" api_version="X.Y.Z">
<portfolios>
<list>
<portfolio>
<report_portfolio_id>the numeric ID of the report in the report portfolio</report_portfolio_id>
<user_id>the numeric ID of the user who created the report</user_id>
<entity_id>the numeric ID of the entity for which the report was created</entity_id>
<name>the name of the report</name>
<description>the description of the report</description>
<visibility>the visibility of the report ('public' | 'private')</visibility>
<creation_time>the time at which the report was created</creation_time>
<last_update_time>the time at which the report was last updated</last_update_time>
<start_period_type>the type of the period start ('fixed' | 'rolling')</start_period_type>
<start>the start time of the period</start>
<end_period_type>the type of the period end ('fixed' | 'rolling')</end_period_type>
<end>the end time of the period</end>
<report_definition>
serialized definition of the report
e.g. for array: a:4:{s:10:"dimensions";a:2:{s:10:"dimension1";s:13:"advertiser_id";}s:7:"filters";a:1:{s:8:"timezone";s:1:"1";}s:11:"filter_vals";a:0:{}s:7:"columns";a:5:{i:0;s:8:"in-imprs";i:1;s:6:"in-ctr";i:2;s:8:"ov-imprs";i:3;s:9:"ov-clicks";i:4;s:6:"ov-ctr";}}
e.g. for json: {"dimensions":{"dimension1":"day","dimension2":"creative_id"},"filters":{"timezone":"2","creative_campaign_id":["xxxx"]},"filter_vals":{"creative_campaign_id":["xxxx"]},"columns":["u-imprs","u-clicks","u-ctr"]}
</report_definition>
<canned_report>yes | no</canned_report>
<url_callback></url_callback>
<root_report>yes/no</root_report>
<report_type>normal/forecast-in/forecast-ov</report_type>
-- report distribution definition -<to>recipient's email addresses (separated by ||)</to>
<subject>email subject</subject>
<frequency>report frequency (daily | weekly | monthly | asap)</frequency>
<hour>the hour at which the report to be sent</hour>
-- for daily frequency -<day>not relevant</day>
-- for weekly frequency -<day>the day of the week (1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday) </day>
-- for monthly frequency -<day>the day of the month (1 - 31)</day>
<message>aditional message sent inside the email</message>
<status>status of the report (active | paused)</status>
<running>the report is currently being generated</running>
<run_start_timestamp>the time at which the report started generating</run_start_timestamp>
<run_end_timestamp>the time at which the report ended generating</run_end_timestamp>
<export_format>the export format (csv|xls|xlsx)</export_format>
<delayed_timestamp>...<delayed_timestamp/>
<delayed_end_timestamp>...<delayed_end_timestamp/>
<until>0000-00-00 00:00:00</until>
</portfolio>
...
</list>
<count>number of report portfolios</count>
</portfolios>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /reports/portfolio/edit

Method Description
Edits an existing report from the report portfolio.
Parameters
Name
Required Type
token
yes
report_portfolio_id yes
name
no
description
no
start_period_type no
start
no
end_period_type no
end
no
Overview
Example
Authentication
session token
string
(received after
/login).
The numerical ID
integer of the report
report_portfolio_id=75
portfolio to be
edited
Portfolio report
string
name=test
name
Portfolio report
string
description=music
name description.
The type of the
report's start time
period. It accepts
2 values: "fixed"
means that that
the start point of
set
be fixed and not start_period_type=fixed
modify over time,
and "rolling"
means that the
start point of the
time period will
increment every
day.
The start time of
DateTime the report's time start=2011-12-22 00:00:00
period.
The type of the
report's end time
period. It accepts
2 values: "fixed"
means that that
the end point of
set
be fixed and not end_period_type=rolling
modify over time,
and "rolling"
means that the
end point of the
time period will
increment every
day
The end time of
string
the report's time end=2011-12-25 00:00:00
visibility
no
last_update_time no
root_report
no
period.
The visibility of
the report. It
accepts 2 values:
"public" or
"private". If you
set this to private
only the user that
set
visibility=public
created it can
access it. If it's
public all users
that can access
that entity can
access the report
portfolio.
DateTime The last update last_update_time=2011-12-25 00:00:00
time of the report.
Specify the type
of the report. The
accepted values
are:
enum
root_report=forecast-in
"normal"|"forecastin"|"forecast-ov".
The default value
is "normal".
A php serialized array containing (the
JSON object structure must to be identical
to the array one): The dimensions array
can contain: dimension1, dimension2,
dimension3, dimension4, dimension5 and
dimension6. For the available values
please look at /statistics.
The filters array must contain: from_date (
the start date yyyy-mm-dd format, for
example 2009-11-01 ), from_time ( the start
time in hh:ii format, for example 23:59 ),
to_date( the end date yyyy-mm-dd format,
for example 2009-11-01 ), to_time ( the end
time in hh:ii format, for example 23:59 ).
Filters can also contain the following keys:
publisher_id ( Site ), connection_id ( Ad
source ), partner_id ( Partner ),
creative_campaign_id ( Creative Group ),
creative_id ( Creative ), advertiser_id (
Advertiser ), location_country ( Country ),
domain_name ( Domain ), order_id ( Order
), order_line_id ( Order Line ), network_id (
Network ), timezone ( Timezone ),
location_region ( State/Region ),
location_metro ( Metro area ), location_city
( City ), video_publisher_video ( Media ID ),
item_name ( Content tag ), browser_id (
Browser ID ), os_id ( Operating system ID ),
autoplay_id (autoplay ID - 0 ( unknown ), 1
( Click to Play ), 2 ( Auto Play )), muted_id
(muted ID 0 ( unknown ), 1 ( Sound on ), 2 (
Sound off )), playersize_id (playersize ID 0
( unknown ), 1 ( small ), 2 ( medium ), 3 (
report_definition no
set

zipcode (Zip Code). For each of this keys (
except for timezone ) you need to give an
array ( even if there's actually a single
value, for example if you want to apply a
filter for connection_id and you want a
single value ( 150 ), you still have to define
filters[connection_id] = array( 150 ) ).
The columns array must contain at least
one column. The available columns are:
accept-invite ( Accepts ), air ( Accept rate ),
c-clicks ( Companion Click-Through ), cimprs ( Companion Impressions ), clicks (
Click-thru's ), clicks-mid ( Click-thru's (mid)
), clicks-post ( Click-thru's (post) ), clickspre ( Click-thru's (pre) ), close-rate ( Close
rate ), closes ( Closes ), complete-rate (
Complete Rate ), ctr ( CTR ), ctrcompanion ( Companion CTR ), ctr-mid (
CTR (mid) ), ctr-post ( CTR (post) ), ctr-pre
( CTR (pre) ), custom1 ( Custom 1 ),
custom2 ( Custom 2 ), custom3 ( Custom 3
), custom4 ( Custom 4 ), custom5 ( Custom
5 ), custom6 ( Custom 6 ), custom7 (
Custom 7 ), custom8 ( Survey ), ecpm (
Revenue eCPM ), ecpm-for-publisher (
Spending eCPM ), imprs ( Impressions ),
imprs-mid ( Impressions (mid) ), imprs-post
( Impressions (post) ), imprs-pre (
Impressions (pre) ), in-clicks ( Click-thru's
(i) ), in-ctr ( CTR (i) ), in-ecpm ( Revenue
eCPM (i) ), in-ecpm-for-publisher (
Spending eCPM (i) ), in-imprs (
Impressions (i) ), in-revenue-advertiser (
Revenue (i) ), in-revenue-publisher (
Spending (i) ), min-rate ( Minimize Rate ),
minimizes ( Minimizes ), mute-rate ( Mute
Rate ), mutes ( Mutes ), ov-clicks ( Clickthru's (o) ), ov-ctr ( CTR (o) ), ov-ecpm (
Revenue eCPM (o) ), ov-ecpm-forpublisher ( Spending eCPM (o) ), ov-imprs
( Impressions (o) ), ov-revenue-advertiser (
Accepts 2 types of Revenue (o) ), ov-revenue-publisher (
data: Serialized Spending (o) ), pause-rate ( Pause Rate ),
Array | JSON.
pauses ( Pauses ), revenue-advertiser (
Revenue ), revenue-publisher ( Spending ),
u-imprs ( Unique Impressions ), u-in-imprs (
Unique Impressions (i) ), u-ov-imprs (
Unique Impressions (o) ), video-ad-plays (
Ad Starts ), watched-100 ( Watched 100%
), watched-25 ( Watched 25% ), watched50 ( Watched 50% ), watched-75 (
Watched 75% ), inventory ( Inventory ),
inventory-in ( Inventory (i) ), inventory-ov (
Inventory (o) ), inventory-pre ( Inventory
(pre) ), inventory-mid ( Inventory (mid) ),
inventory-post ( Inventory (post) ),
inventory-fill ( Inventory Fill ), inventory-fillin ( Inventory Fill (i) ), inventory-fill-ov (
Inventory Fill (o) ), inventory-fill-pre (
Inventory Fill (pre) ), inventory-fill-mid (
Inventory Fill (mid) ), inventory-fill-post (
Inventory Fill (post) ), ad-requests ( Ad

Requests ), ad-requests-in ( Ad Requests
(i) ), ad-requests-ov ( Ad Requests (o) ),
ad-requests-pre ( Ad Requests (pre) ), adrequests-mid ( Ad Requests (mid) ), adrequests-post ( Ad Requests (post) ), adrequests-fill ( Ad Requests Fill ), adrequests-fill-in ( Ad Requests Fill (i) ), adrequests-fill-ov ( Ad Requests Fill (o) ), adrequests-fill-pre ( Ad Requests Fill (pre) ),
ad-requests-fill-mid ( Ad Requests Fill (mid)
), ad-requests-fill-post ( Ad Requests Fill
(post) ).
Safari, 60 / Silk.
The supported os_id / os_name are: 0 /
**If you have order_id and/or
order_line_id specified anywhere, the
following columns are not accepted:
"slots","in-slots","ov-slots","slots-pre","slotsmid","slots-post", "fill-rate-pre","fill-ratemid","fill-rate-post","fill-rate","slots-unique",
"in-slots-unique","ov-slots-unique","inrate","ov-rate","rate-unique", "in-rateunique","ov-rate-unique","ad-requests","adrequests-in", "ad-requests-ov","adrequests-pre","ad-requests-mid", "adrequests-post","inventory-1","inventory2","inventory","inventory-1-in", "inventory-2in","inventory-in","inventory-1ov","inventory-2-ov","inventory-ov",
"inventory-1-pre","inventory-2pre","inventory-pre","inventory-1-mid",
"inventory-2-mid","inventorymid","inventory-1-post","inventory-2-post",
"inventory-post","u-inventory-1","uinventory-2","u-inventory", "u-inventory-1in","u-inventory-2-in","u-inventory-in","uinventory-1-ov", "u-inventory-2-ov","uinventory-ov","u-inventory-1-pre","uinventory-2-pre", "u-inventory-pre","uinventory-1-mid","u-inventory-2-mid","uinventory-mid", "u-inventory-1-post","uinventory-2-post","u-inventorypost","inventory-fill", "inventory-fillin","inventory-fill-ov","inventory-fillpre","inventory-fill-mid", "inventory-fill-post".
Return
<liverailapi requested="/reports/portfolio/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
21 August 2012
11 September 2012
Description
Added Content Type
Added non-valid parameters
Reason
Align with API
Align with API
Method Name: /reports/portfolio/delete

Method Description
Delete a report from report portfolio.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
integer report
portfolio to be
deleted.
Return
<liverailapi requested="/reports/portfolio/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
REPORT PORTFOLIO SCHEDULES
All the methods related to report portfolios schedules are displayed here.
/reports/portfolio/schedule/add
/reports/portfolio/schedule/edit
/reports/portfolio/schedule/list
/reports/portfolio/schedule/delete
Method Name: /reports/portfolio/schedule/list

Method Description
List the report schedule (if any) of (a) report(s) from the report portfolio.
Parameters
Name

Authentication
token
yes
(received
after /login).
The numeric
ID of the
report
portfolio. You
can send a
integer
single ID or a
list of IDs by
glueing them
together with
"|"
Return
<liverailapi requested="/reports/portfolio/schedule/list" api_version="X.Y.Z">
<schedules>
<schedule>
<report_portfolio_id>the numeric ID of the report in the report portfolio</report_portfolio_id>
<to>recipient's email addresses (separated by ||)</to>
<subject>email subject</subject>
<frequency>report frequency (daily | weekly | monthly | asap)</frequency>
<hour>the hour at which the report to be sent</hour>
-- for daily frequency -<day>not relevant</day>
-- for weekly frequency -<day>the day of the week (1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday) </day>
-- for monthly frequency -<day>the day of the month (1 - 31)</day>
<message>aditional message sent inside the email</message>
<status>status of the report (active | paused)</status>
<running>the report is currently being generated</running>
<run_start_timestamp>the time at which the report started generating</run_start_timestamp>
<run_end_timestamp>the time at which the report ended generating</run_end_timestamp>
<export_format>the export format (csv|xls|xlsx)</export_format>
<url_callback>the POST URL for callback (optional)</url_callback>
<delayed_timestamp>...<delayed_timestamp/>
<delayed_end_timestamp>...<delayed_end_timestamp/>
<until>0000-00-00 00:00:00</until>
</schedule>
...
</schedules>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /reports/portfolio/schedule/add

Method Description
Add a report portfolio schedule.
Parameters
Name
Required Type
token
yes
to
yes
subject
yes
frequency
yes
hour
yes
day
yes
status
yes
until
yes
Overview
Example
Authentication
session
token
string
The numerical ID of the report
integer portfolio for which the schedule report_portfolio_id=75
is added.
The email address to which the
report should be sent. More than
string
one email address can be
[email protected]
specified by glueing them
together with "|"
The subject to be used in the
string
subject=report
email,
The frequency of the report
generation. The possible values
are:
"daily"|"weekly"|"monthly"|"asap".
if frequency = daily --> time
duration of report can only be 1
day max or month to date
enum
frequency=daily
(exception to the rule)
if frequency = weekly --> time
days max
if frequency = monthy --> time
days max
DateTime The time of sending the report. hour=12
For daily frequency the value is
not relevant. For weekly
frequency the value represents
the day of the week (1 - Monday,
enum
day=7
2 - Tuesday, 3 - Wednesday ).
For monthly frequency the value
represents the day of the month
(1 - 31)
The report's status. The possible
enum
status=active
values are: "active", "paused"
Specify for "start_period_type"
fixed and "end_period_type"
"rolling". When the 'Until' date is
met, the report will automatically
be 'Paused'. Must be shorter
than 1 year. If both
"start_period_type" and
DateTime "end_period_type" are "fixed", until=2012-06-15 00:00:00
"until" does not have any
function. If both
"end_period_type" are "rolling",
"until" is optional. If
"start_period_type" is fixed and
"end_period_type" is "rolling",
"until" is mandatory.
An URL callback where the
url_callback
yes
string
scheduler will call ( via POST )

when the report is completed.
The POST fields will be
lr_export_file ( the URL from
where the export file can be
downloaded ) and
lr_report_portfolio_id ( the
numerical ID of the report
portfolio )
url_callback=
Return
<liverailapi requested="/reports/portfolio/schedule/add" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /reports/portfolio/schedule/edit

Method Description
Edit a report portfolio schedule.
Parameters
Name
Required Type
token
yes
to
no
subject
no
frequency
no
hour
no
day
no
status
no
until
no
Overview
Example
Authentication
session
token
string
The numerical ID of the report
integer portfolio for which the schedule report_portfolio_id=75
is edited.
The email address to which the
report should be sent. More than
string
one email address can be
[email protected]
specified by glueing them
together with "|"
The subject to be used in the
string
subject=report
email,
The frequency of the report
generation. The possible values
are:
"daily"|"weekly"|"monthly"|"asap".
if frequency = daily --> time
day max or month to date
set
frequency=daily
(exception to the rule)
if frequency = weekly --> time
days max
if frequency = monthy --> time
days max
DateTime The time of sending the report. hour=12
For daily frequency the value is
not relevant. For weekly
frequency the value represents
the day of the week (1 - Monday,
set
day=7
2 - Tuesday, 3 - Wednesday ).
For monthly frequency the value
represents the day of the month
(1 - 31)
The report's status. The possible
values are: "active", "paused".
Be aware that when the
set
status=active
schedule status is set to paused,
it will not perform anything else
anymore.
Specify for "start_period_type"
fixed and "end_period_type"
"rolling". When the 'Until' date is
met, the report will automatically
be 'Paused'. Must be shorter
than 1 year. If both
DateTime "end_period_type" are "fixed", until=2012-06-15 00:00:00
"until" does not have any
function. If both
"end_period_type" are "rolling",
"until" is optional. If
url_callback
no
string
"start_period_type" is fixed and

"end_period_type" is "rolling",
"until" is mandatory.
An URL callback where the
scheduler will call ( via POST )
when the report is completed.
The POST fields will be
lr_export_file ( the URL from
url_callback=
where the export file can be
downloaded ) and
lr_report_portfolio_id ( the
numerical ID of the report
portfolio )
Return
<liverailapi requested="/reports/portfolio/schedule/edit" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
The behaviour of the status has been changed when
10.01.2012
set to "paused"
Reason
To ensure the
full...
Method Name: /reports/portfolio/schedule/delete

Method Description
Delete a report portfolio schedule.
Parameters
Name

Authentication
token
yes
(received
after /login).
TThe
numerical ID
of the report
integer portfolio from report_portfolio_id=75
which the
schedule is
deleted.
Return
<liverailapi requested="/reports/portfolio/schedule/delete" api_version="X.Y.Z">
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
COMSCORE
All the methods related to ComScore are displayed here.

/comscore/target/list
/comscore/domain/list
Method Name: /comscore/target/list

Method Description
Returns the list of comscore targets.
Parameters
Authentication
token yes
(received after
/login).
Example
Return
<liverailapi requested="/comscore/target/list" api_version="x.y.z">
<targets>
<target>
<target_id></target_id>
<target_name></target_name>
</target>
...
</targets>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
Method Name: /comscore/domain/list

Method Description
Returns the list of comscore domains.
Parameters
Name

Example
Authentication
token yes
(received after
/login).
The id of the target.
Multiple IDs can be
integer bind together by "|" token=f5a81cdde43c6334feffcfc13ad53717
target_id yes
or ",". Retrieve the
target_id from
/comscore/target/list
Return
<liverailapi requested="/comscore/domain/list" api_version="x.y.z">
<domains>
<domain>
<domain_index></domain_index>
<domain_name></domain_name>
</domain>
...
</domain>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
3RD PARTY INTEGRATION
All the methods related to 3rd party integration are listed here.
/contextual/segments/get
Method Name: /contextual/segments/get

Method Description
List all the contextual data for segments.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
Search based on
the segment
string source. The
segment_source no
segment_source=adsafe
possible values
are: "adsafe" ,
"proximic"
Return only the
segments with the
string name that are
search_string no
search_string=ads
LIKE
%search_string%.
Limit the number
of results for
integer pagination(s).
limit
no
limit=10
This parameter is
optional.
The offset from
where the limit
should be applied
( if you display 10
items per page
and you need to
get the 3rd page
string you should set offset=20
offset
no
offset to 20 and
limit to 10 ). This
parameter is
optional and
shouldn't be given
without giving the
limit parameter as
well.
Return
<liverailapi requested="/contextual/segment/get" api_version="x.y.x">
<contextual_segment_list>
<contextual_segment>
<segment_id>The numeric ID of the segment</segment_id>
<segment_source>The numeric ID of the segment data</segment_data_id>
<segment_code>string: the segment code</segment_code>

<segment_name>segment name</segment_name>
<segment_type>segment type</type>
<segment_price>float: segment price</segment_price>
</segment_segment>
...
</contextual_segment_list>
...
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
Description
Reason
QC ADVERTISER
All the methods related to QC Advertiser are listed here.

/qc/advertiser/list
Method Name: /qc/advertiser/list

Method Description
List all the available QC advertisers.
Parameters
Name

Example
Authentication
token
yes
(received after
/login).
The numeric ID of
the QC Advertiser
for which the
information will be
integer returned. If you qc_advertiser_id = 1|7|120 or
qc_advertiser_id
no
have multiple id(s) qc_advertiser_id = 1,7,120
you can make a
single call by
glueing them
Search based on
string the QC Advertiser qc_advertiser_name = Test Advertiser
qc_advertiser_name no
full name.
Limit the number
limit
no
limit=50
pagination(s).
The offset from
where the limit
should be applied
( if you display 10
results per page
and you need to
integer get the 3rd page offset=5
offset
no
you should set
offset to 20 and
limit to 10 ). Do
not use without
specifying the
limit parameter as
well.
Return only QC
Advertisers with
string the name that are search_string=test
search_string
no
LIKE
%search_string%.
Return
<liverailapi requested="/qc/advertiser/list" api_version="X.Y.Z">
<qc_advertisers>
<list>
<qc_advertiser>
<qc_advertiser_id>The numeric ID of the QC Advertiser</qc_advertiser_id>
<qc_advertiser_name>string: the QC Advertiser name</qc_advertiser_name>
</qc_advertiser>
...
</list>
...
</qc_advertisers>
<user> ... </user>
<auth> ... </auth>
...
</liverailapi>
Change History
Date
31 July 2012
Description
Reason
Align with API

LiveRail API

Uploaded by

Copyright:

Available Formats

LiveRail API

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

LiveRail API

Uploaded by

Copyright:

Available Formats

APPLICATION PROGRAMMING INTERFACE

LiveRail API Foreword

LOGGING IN AND OUT

Method Name: /login

Required Type Overview

Method Name: /logout

SET / UNSET ENTITY

Method Name: /set/entity

Method Name: /unset/entity

All the methods related to entities are displayed here.

Method Name: /entity/list

Required Type Overview Example

<type>type of the entity, internal use</type>

Added auto_retarget, updated status values.

Removed bid_optimization, moved to

Added 2 more parameters

Added 1 more inte parameter

Added 1 more inte parameter

08 January 2013 Added rtb_enabled

Method Name: /entity/resolve/name

Method Name: /entity/list/bychar

Method Name: /entity/add

Required Type Overview

"no", the following actions:

Updated status with cancelled.

Removed bid_optimization, moved to

Added 2 more inte parameters

Added 1 more inte parameter

Added 1 more inte parameter

08 January 2013 Added rtb_enabled

Method Name: /entity/edit

Required Type Overview

enum parameter is optional,

. This parameter is optional,

altered in any way.

optional, meaning that, if not

Updated status with cancelled.

Removed bid_optimization, moved to

Added 2 more inte parameters

Added 1 more inte parameter

Added 1 more inte parameter

08 January 2013 Added rtb_enabled

Method Name: /entity/delete

Method Name: /entity/exchange/list

Method Name: /entity/publisher/category/list

Method Name: /entity/network/type/list

Method Name: /entity/network/type/list

Method Name: /entity/integration/get

All the methods related to users are displayed here.

Method Name: /user/list

Required Type Overview

Method Name: /user/add

Required Type Overview

<liverailapi requested="/user/add" api_version="X.Y.Z">

Method Name: /user/edit

Required Type Overview Example

Method Name: /user/delete

Method Name: /user/recover

Required Type Overview Example