Description: This document lists and describes the API calls used to obtain uplift metric data (Enterprise customers only) for the measurement and optimization of TV campaigns.


Authentication

The Innovid API requires you to authenticate with InnovidXP so that you can access your client and brand data. You will need to set up and use basic authentication to access the available Innovid Attribution API endpoints. This requires a Basic HTTP Authorization header to be sent with each request.

For more information on the HTTP Authorization header, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization.

Making calls to the API

The API uses basic authentication over an https connection. To authenticate, you must send an HTTP Authorization header with every API call, containing a hash of the username and password specified previously for use with the Attribution API.

  1. To authenticate with the Attribution API using the curl command, use the following command line, substituting the username and password of the API user:
    curl --user <api_username>:<api_password> https://apixx.tvsquared.com

  2. Alternatively, you can use a separate 3rd-party command line tool, or your preferred programming language, to generate the authentication header.

Setup

The base URL is appended with uplift so that the base URL for the uplift endpoint becomes:

https://<partnerdomain>/api/v2/uplift///////////

 


All URLs in this section start with this base URL.

The Innovid Uplift Metric API is a standard RESTful HTTP API based on GET, POST, and DELETE requests with JSON formatted responses.

The API exclusively uses the HTTPS protocol for encryption and data security - plain HTTP requests are blocked and will not be successful. 

All API endpoints share the same base URL, accessed at the partner level:

https://<partnerdomain>.tvsquared.com/api/v2/

where <partnerdomain> is a unique identifier for the API in the format api-xx. Use your <partnerdomain> for the base URL for all API endpoints.


Inventory

Performing a GET request at the following endpoint returns uplift metric information for the specified client, action, medium, date from, and date to.

URL

https://<partnerdomain>/api/v2/uplift/<clientslug>/<brand>/<uaction>/<media>/<y1>/<m1>/<d1>/<y2>/<m2>/<d2>


The <y1>, and <y2> parameters represent the start and end dates of the date range you want to view uplift metrics for.


Parameters

All date and time parameters are formatted in the ISO standard as follows unless otherwise stated:

  • Date: YYYY-MM-DD
  • Datetime: YYYY-MM-DDThh:mm:ss

Client ID and brand ID are used in several API endpoints, identified by <clientid> and <brandid>, respectively. 

These are unique identifiers for the required client and brand and can be derived from the InnovidXP portal.

Parameter Description
MEDIA A list of the media types, for example, web, app, phone, sms.
UACTION A list of available response actions, for example, all response, signup, subscription.

 

Example response format



 "selectedperiod" :{

 "upliftpercentage":<value>

},

 "previousperiod" :{

 "upliftpercentage":<value>

},

  "difference" :{

  "percentage": <value>

},

}

 

Additional information

The API will return these uplift values:

Parameter Description
selectedperiod The date range requested in the API call.
previousperiod The date range before the selectedperiod, calculated from the dateto minus the number of days in the date range from selectedperiod.
difference The percentage difference in uplift between the selectedperiod and the previousperiod.
upliftpercentage The value as a percentage.

Related content:

InnovidXP Collector API User Guide

Was this article helpful?
0 out of 0 found this helpful