Metric
Get external creative metrics for a line item.
POST
/
api
/
manager
/
metric
/
line-item
/
external-creatives
Get external creative metrics for a line item.
curl --request POST \
--url https://your_a2_service/api/manager/metric/line-item/external-creatives \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from_datetime": "2023-11-07T05:31:56Z",
"line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to_datetime": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://your_a2_service/api/manager/metric/line-item/external-creatives"
payload = {
"from_datetime": "2023-11-07T05:31:56Z",
"line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to_datetime": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from_datetime: '2023-11-07T05:31:56Z',
line_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
to_datetime: '2023-11-07T05:31:56Z'
})
};
fetch('https://your_a2_service/api/manager/metric/line-item/external-creatives', 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://your_a2_service/api/manager/metric/line-item/external-creatives",
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([
'from_datetime' => '2023-11-07T05:31:56Z',
'line_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'to_datetime' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://your_a2_service/api/manager/metric/line-item/external-creatives"
payload := strings.NewReader("{\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your_a2_service/api/manager/metric/line-item/external-creatives")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/api/manager/metric/line-item/external-creatives")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"is_date_range_exceeded": true,
"is_truncated": true,
"items": [
{
"crid": "<string>",
"source": "<string>",
"source_name": "<string>",
"ad_revenue": 0,
"budget_spent": 0,
"click": 0,
"conversion": 0,
"cpc": 0,
"cpm": 0,
"ctr": 0,
"cvr": 0,
"ecpm": 0,
"impression": 0,
"reach": 0
}
],
"total_count": 123,
"max_days": 14,
"threshold": 10000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.
Body
application/json
Response
Successful Response
True when the requested date range exceeds max_days
True when total_count exceeds threshold and results are omitted
Show child attributes
Show child attributes
Total number of distinct creatives matching the query
Max allowed date range in days
Max distinct creative count before truncation
Was this page helpful?
⌘I
Get external creative metrics for a line item.
curl --request POST \
--url https://your_a2_service/api/manager/metric/line-item/external-creatives \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from_datetime": "2023-11-07T05:31:56Z",
"line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to_datetime": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://your_a2_service/api/manager/metric/line-item/external-creatives"
payload = {
"from_datetime": "2023-11-07T05:31:56Z",
"line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"to_datetime": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from_datetime: '2023-11-07T05:31:56Z',
line_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
to_datetime: '2023-11-07T05:31:56Z'
})
};
fetch('https://your_a2_service/api/manager/metric/line-item/external-creatives', 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://your_a2_service/api/manager/metric/line-item/external-creatives",
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([
'from_datetime' => '2023-11-07T05:31:56Z',
'line_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'to_datetime' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://your_a2_service/api/manager/metric/line-item/external-creatives"
payload := strings.NewReader("{\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your_a2_service/api/manager/metric/line-item/external-creatives")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/api/manager/metric/line-item/external-creatives")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"line_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"is_date_range_exceeded": true,
"is_truncated": true,
"items": [
{
"crid": "<string>",
"source": "<string>",
"source_name": "<string>",
"ad_revenue": 0,
"budget_spent": 0,
"click": 0,
"conversion": 0,
"cpc": 0,
"cpm": 0,
"ctr": 0,
"cvr": 0,
"ecpm": 0,
"impression": 0,
"reach": 0
}
],
"total_count": 123,
"max_days": 14,
"threshold": 10000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}