Get a single Allocation by query

GET

api

manager

allocations

allocation

Get a single Allocation by query

curl --request GET \
  --url https://your_a2_service/api/manager/allocations/allocation \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your_a2_service/api/manager/allocations/allocation', 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/allocations/allocation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_a2_service/api/manager/allocations/allocation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/api/manager/allocations/allocation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rtype": "line_item",
  "tid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ttype": "ad_unit",
  "updated_at": "2023-11-07T05:31:56Z",
  "ext": {
    "ad_log_tracking_mode": "on_ad_response",
    "deferred_native_rendering": false,
    "deferred_native_template": "",
    "frequency_capping": {
      "enabled": 0,
      "limit_multiple_click": 0,
      "limit_user_impression": [
        {
          "limit_count": 0,
          "num_time_units": 0,
          "time_unit": "day"
        }
      ]
    },
    "supported_environments": [
      "web",
      "app"
    ]
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_comment": "",
  "line_item_end_date": "2023-11-07T05:31:56Z",
  "line_item_name": "<string>",
  "line_item_oid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "line_item_start_date": "2023-11-07T05:31:56Z",
  "line_item_status": "<string>",
  "no": 0,
  "owner_name": "<string>",
  "status": "pending",
  "target_ext": {
    "algorithm": "axa0",
    "approval_method": "admin",
    "bcat": [],
    "default_cpa": 0,
    "default_cpc": 0,
    "display": {
      "enabled": 0
    },
    "external_raw_data": "<unknown>",
    "implicit_app_inference": {
      "android_bundle": "<string>",
      "app_name": "<string>",
      "cat": [
        "<string>"
      ],
      "ios_bundle": "<string>",
      "ua_keywords": []
    },
    "metric_mode": "all",
    "native": {
      "enabled": 0,
      "render_mode": "html"
    },
    "passback": "<unknown>",
    "payout": "rates",
    "public_url": "<string>",
    "publisher": "<unknown>",
    "recommendation": {
      "enabled": 0
    },
    "responsive": "fixed",
    "target_ecpm": 0,
    "target_service": "<string>",
    "video": {
      "enabled": 0
    }
  },
  "target_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.

Query Parameters

ttype

enum<string> | null

Target type (ad_unit | placement)

Available options:

ad_unit,

placement

tid

string<uuid>[] | null

Target ID(s) — repeatable: ?tid=X&tid=Y

rtype

enum<string> | null

Resource type (line_item | recommendation_policy)

Available options:

line_item,

recommendation_policy

rid

string<uuid> | null

Resource ID

status

enum<string> | null

Allocation status

Available options:

pending,

requested,

published,

rejected,

canceled,

finished

owner_id

string<uuid> | null

Owner ID

Response

Successful Response

Response schema for allocation read operations — includes enriched name fields.

created_at

string<date-time>

required

owner_id

string<uuid>

required

Owner ID

rid

string<uuid>

required

Resource ID (line_items.id or recommendation_policies.id)

rtype

enum<string>

required

Resource type allocated to the target (line_item / recommendation_policy)

Available options:

line_item,

recommendation_policy

tid

string<uuid>

required

Target ID (ad_units.id or placements.id)

ttype

enum<string>

required

Target type (ad_unit / placement)

Available options:

ad_unit,

placement

updated_at

string<date-time>

required

ext

AllocationExt · object

for various configuration

Show child attributes

string<uuid> | null

last_comment

string

default:""

Last comment

line_item_end_date

string<date-time> | null

End date of the line item

line_item_name

string | null

Name of the line item

line_item_oid

string<uuid> | null

Order ID of the line item

line_item_start_date

string<date-time> | null

Start date of the line item

line_item_status

string | null

Status of the line item

integer

default:0

ID of the allocation

owner_name

string | null

Name of the allocation owner

status

enum<string>

default:pending

The current status of the allocation (e.g. pending, published, rejected)

Available options:

pending,

requested,

published,

rejected,

canceled,

finished

target_ext

AdUnitExt · object | null

Ext of the target (ad_unit only)

Show child attributes

target_name

string | null

Name of the target (ad unit or placement)

Get a single Allocation by query

curl --request GET \
  --url https://your_a2_service/api/manager/allocations/allocation \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your_a2_service/api/manager/allocations/allocation', 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/allocations/allocation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_a2_service/api/manager/allocations/allocation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/api/manager/allocations/allocation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rtype": "line_item",
  "tid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ttype": "ad_unit",
  "updated_at": "2023-11-07T05:31:56Z",
  "ext": {
    "ad_log_tracking_mode": "on_ad_response",
    "deferred_native_rendering": false,
    "deferred_native_template": "",
    "frequency_capping": {
      "enabled": 0,
      "limit_multiple_click": 0,
      "limit_user_impression": [
        {
          "limit_count": 0,
          "num_time_units": 0,
          "time_unit": "day"
        }
      ]
    },
    "supported_environments": [
      "web",
      "app"
    ]
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_comment": "",
  "line_item_end_date": "2023-11-07T05:31:56Z",
  "line_item_name": "<string>",
  "line_item_oid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "line_item_start_date": "2023-11-07T05:31:56Z",
  "line_item_status": "<string>",
  "no": 0,
  "owner_name": "<string>",
  "status": "pending",
  "target_ext": {
    "algorithm": "axa0",
    "approval_method": "admin",
    "bcat": [],
    "default_cpa": 0,
    "default_cpc": 0,
    "display": {
      "enabled": 0
    },
    "external_raw_data": "<unknown>",
    "implicit_app_inference": {
      "android_bundle": "<string>",
      "app_name": "<string>",
      "cat": [
        "<string>"
      ],
      "ios_bundle": "<string>",
      "ua_keywords": []
    },
    "metric_mode": "all",
    "native": {
      "enabled": 0,
      "render_mode": "html"
    },
    "passback": "<unknown>",
    "payout": "rates",
    "public_url": "<string>",
    "publisher": "<unknown>",
    "recommendation": {
      "enabled": 0
    },
    "responsive": "fixed",
    "target_ecpm": 0,
    "target_service": "<string>",
    "video": {
      "enabled": 0
    }
  },
  "target_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Data Management APIs

Decision APIs

Get a single Allocation by query

Authorizations

Query Parameters

Response