Run Report
curl --request POST \
--url https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting \
--header 'Content-Type: application/json' \
--header 'X-apikey: <api-key>' \
--data '{
"Columns": []
}'import requests
url = "https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting"
payload = { "Columns": [] }
headers = {
"X-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-apikey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Columns: []})
};
fetch('https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Columns' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting"
payload := strings.NewReader("{\n \"Columns\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting")
.header("X-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Columns\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Columns\": []\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"line_item_id": 1234567891234567,
"client_id": 1234567891234567,
"account_id": 1234567891234567,
"campaign_id": 1234567891234567,
"product_id": 1234567891234567,
"line_item_name": "",
"assignees": "",
"partner_discount": 0.1,
"quantity": 1234567891234567,
"partner_rate": "",
"fulfillment_cost": "",
"line_item_budget": "",
"line_item_fulfillment": 0.1,
"line_item_status": "",
"start_date": {
"value": "2014-12-31"
},
"end_date": {
"value": "2014-12-31"
},
"product_name": "",
"source_market": "",
"source_market_abbreviation": "",
"product_description": "",
"platform": "",
"channel": "",
"format_aspect": "",
"cost_basis_id": 1234567891234567,
"rate_card": "",
"minimum_partner_budget": "",
"mark_up": false,
"mark_up_value": "",
"source_market_id": 1234567891234567,
"campaign_name": "",
"campaign_type": "",
"campaign_managers_id": 1234567891234567,
"campaign_budget": "",
"campaign_brief_field_id": "",
"campaign_status": "",
"account_name": "",
"account_type": "",
"contacts": "",
"sales_manager": "",
"product_ids": "",
"client_name": "",
"url": "",
"impressions": 1234567891234567,
"clicks": 1234567891234567,
"spend": 1234567891234567,
"conversions": 1234567891234567,
"completion_capped": 0.1,
"pacing": 0.1
}
],
"pagination": {
"page": 1234567891234567,
"limit": 1234567891234567,
"total": 1234567891234567,
"pages": 1234567891234567
}
}Reporting
Run Report
POST
/
Reporting
Run Report
curl --request POST \
--url https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting \
--header 'Content-Type: application/json' \
--header 'X-apikey: <api-key>' \
--data '{
"Columns": []
}'import requests
url = "https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting"
payload = { "Columns": [] }
headers = {
"X-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-apikey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Columns: []})
};
fetch('https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Columns' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting"
payload := strings.NewReader("{\n \"Columns\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting")
.header("X-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Columns\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.uplifthub.io/P195_Exposed_Integrations/rest/V1/Reporting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Columns\": []\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"line_item_id": 1234567891234567,
"client_id": 1234567891234567,
"account_id": 1234567891234567,
"campaign_id": 1234567891234567,
"product_id": 1234567891234567,
"line_item_name": "",
"assignees": "",
"partner_discount": 0.1,
"quantity": 1234567891234567,
"partner_rate": "",
"fulfillment_cost": "",
"line_item_budget": "",
"line_item_fulfillment": 0.1,
"line_item_status": "",
"start_date": {
"value": "2014-12-31"
},
"end_date": {
"value": "2014-12-31"
},
"product_name": "",
"source_market": "",
"source_market_abbreviation": "",
"product_description": "",
"platform": "",
"channel": "",
"format_aspect": "",
"cost_basis_id": 1234567891234567,
"rate_card": "",
"minimum_partner_budget": "",
"mark_up": false,
"mark_up_value": "",
"source_market_id": 1234567891234567,
"campaign_name": "",
"campaign_type": "",
"campaign_managers_id": 1234567891234567,
"campaign_budget": "",
"campaign_brief_field_id": "",
"campaign_status": "",
"account_name": "",
"account_type": "",
"contacts": "",
"sales_manager": "",
"product_ids": "",
"client_name": "",
"url": "",
"impressions": 1234567891234567,
"clicks": 1234567891234567,
"spend": 1234567891234567,
"conversions": 1234567891234567,
"completion_capped": 0.1,
"pacing": 0.1
}
],
"pagination": {
"page": 1234567891234567,
"limit": 1234567891234567,
"total": 1234567891234567,
"pages": 1234567891234567
}
}Authorizations
Body
application/json
Columns to include in the report. Reporting is at line item level — each row returned represents a single line item, and every column describes that line item or the campaign/account/product it belongs to. Valid values:
line_item_id: Unique numeric ID of this line item.client_id: Unique numeric ID of the client associated with this line item.account_id: Unique numeric ID of the account (partner) associated with this line item.campaign_id: Unique numeric ID of the campaign this line item belongs to.product_id: Unique numeric ID of the product booked on this line item.line_item_name: Display name of this line item.assignees: JSON string array of users assigned to this line item, each withnameandrole.partner_discount: Discount percentage applied to the partner rate on this line item.quantity: Number of units/placements booked on this line item.partner_rate: Rate charged to the partner for this line item.fulfillment_cost: Internal cost to fulfil this line item.line_item_budget: Total budget allocated to this line item.line_item_fulfillment: Amount fulfilled against this line item's budget so far.media_cost: Media cost associated with this line item, if applicable.ecpm: Effective cost per mille (CPM) for this line item, if applicable.line_item_status: Current status label of this line item (e.g. Complete, Live).start_date: Start date of this line item.end_date: End date of this line item.product_name: Name of the product booked on this line item.source_market: Name of the source market the parent campaign originates from.source_market_abbreviation: Abbreviation of the source market the parent campaign originates from.product_description: Description of the product booked on this line item.platform: Platform this line item runs on (e.g. On-Site).channel: Channel of the product booked on this line item.format_aspect: Ad format/aspect spec for the product booked on this line item.cost_basis_id: ID of the cost basis used to price the product on this line item (e.g. CPM, flat fee).rate_card: Standard rate card price for the product booked on this line item.minimum_partner_budget: Minimum partner budget required for the product booked on this line item.mark_up: Whether a mark-up is applied to the product on this line item.mark_up_value: Mark-up percentage/value applied on this line item, if any.source_market_id: Unique numeric ID of the source market the parent campaign originates from.campaign_name: Display name of the campaign this line item belongs to.campaign_type: Type of the campaign this line item belongs to (e.g. Custom Campaign).campaign_managers_id: ID of the campaign manager assigned to the parent campaign.package: Name of the package the parent campaign/line item belongs to, if part of a package deal.package_fixed_commitment_total: Total fixed commitment value for the package, if this line item is part of one.package_blended_total_commitment: Total blended commitment value for the package, if this line item is part of one.campaign_budget: Total budget for the campaign this line item belongs to.campaign_brief_field_id: Comma-separated IDs of the brief fields on the parent campaign.campaign_status: Current status of the campaign this line item belongs to (e.g. Closed).account_name: Name of the account (partner) associated with this line item.account_type: Type of the account associated with this line item (e.g. Tourist Board).contacts: JSON string of contact details for the account associated with this line item.sales_manager: Name of the sales manager on the account associated with this line item.product_ids: JSON array of all product IDs available to the account associated with this line item.client_name: Name of the client associated with this line item.url: Direct link to this line item's detail page in Uplift Hub.impressions: Total impressions delivered for this line item.clicks: Total clicks delivered for this line item.spend: Total spend recorded against this line item.conversions: Total conversions recorded for this line item.completion_capped: Delivery completion percentage for this line item, capped at 100.pacing: Delivery pacing percentage for this line item, relative to plan.line_item_tags: Tags applied directly to this line item.campaign_tags: Tags applied to the campaign this line item belongs to.all_tags: Combined tags from both this line item and its parent campaign.
Available options:
line_item_id, client_id, account_id, campaign_id, product_id, line_item_name, assignees, partner_discount, quantity, partner_rate, fulfillment_cost, line_item_budget, line_item_fulfillment, media_cost, ecpm, line_item_status, start_date, end_date, product_name, source_market, source_market_abbreviation, product_description, platform, channel, format_aspect, cost_basis_id, rate_card, minimum_partner_budget, mark_up, mark_up_value, source_market_id, campaign_name, campaign_type, campaign_managers_id, package, package_fixed_commitment_total, package_blended_total_commitment, campaign_budget, campaign_brief_field_id, campaign_status, account_name, account_type, contacts, sales_manager, product_ids, client_name, url, impressions, clicks, spend, conversions, completion_capped, pacing, line_item_tags, campaign_tags, all_tags Was this page helpful?