Analytic
Get a placement metric
Retrieves metrics for a specific placement identified by the query.
POST
/
metric
/
placements
Get a placement metric
curl --request POST \
--url https://your_a2_service/metric/placements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_datetime": "2023-11-07T05:31:56Z",
"to_datetime": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://your_a2_service/metric/placements"
payload = {
"tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_datetime": "2023-11-07T05:31:56Z",
"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({
tagid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
from_datetime: '2023-11-07T05:31:56Z',
to_datetime: '2023-11-07T05:31:56Z'
})
};
fetch('https://your_a2_service/metric/placements', 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/metric/placements",
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([
'tagid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'from_datetime' => '2023-11-07T05:31:56Z',
'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/metric/placements"
payload := strings.NewReader("{\n \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\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/metric/placements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/metric/placements")
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 \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"ad_revenue": 123,
"id": 123,
"tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_campaigns": 0,
"budget_spent": 0,
"click": 0,
"conversion": 0,
"ecpm": 0,
"impression": 0,
"reach": 0
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Response
Successful Response
Schema for placement metric entity.
Ad Revenue
The placement ID
Number of active campaigns on the placement
Budget spent
Click
Conversion
Effective Cost Per Mille
Impression
Reach
Was this page helpful?
⌘I
Get a placement metric
curl --request POST \
--url https://your_a2_service/metric/placements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_datetime": "2023-11-07T05:31:56Z",
"to_datetime": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://your_a2_service/metric/placements"
payload = {
"tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"from_datetime": "2023-11-07T05:31:56Z",
"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({
tagid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
from_datetime: '2023-11-07T05:31:56Z',
to_datetime: '2023-11-07T05:31:56Z'
})
};
fetch('https://your_a2_service/metric/placements', 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/metric/placements",
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([
'tagid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'from_datetime' => '2023-11-07T05:31:56Z',
'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/metric/placements"
payload := strings.NewReader("{\n \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\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/metric/placements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/metric/placements")
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 \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"from_datetime\": \"2023-11-07T05:31:56Z\",\n \"to_datetime\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"ad_revenue": 123,
"id": 123,
"tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active_campaigns": 0,
"budget_spent": 0,
"click": 0,
"conversion": 0,
"ecpm": 0,
"impression": 0,
"reach": 0
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}