Skip to content

Get audience traffic

POST
/inventory/traffic
curl --request POST \
--url https://ads.wortise.com/api/public/v1/inventory/traffic \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "banners": [ 1 ], "coordinates": true, "end": "2026-04-15T12:00:00Z", "slices": 1, "start": "2026-04-15T12:00:00Z", "user": true, "campaigns": [ 1 ] }'

Returns the impression and click traffic of an audience, broken down by app, device, location and user.

Requires the inventory:read scope.

Media typeapplication/json
object
banners
Array<number>
coordinates
boolean
end
required

YYYY-MM-DDTHH:MM:SSZ

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
slices
integer
>= -9007199254740991 <= 9007199254740991
start
required

YYYY-MM-DDTHH:MM:SSZ

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
user
boolean
campaigns
Array<number>

Example generated

{
"banners": [
1
],
"coordinates": true,
"end": "2026-04-15T12:00:00Z",
"slices": 1,
"start": "2026-04-15T12:00:00Z",
"user": true,
"campaigns": [
1
]
}

Inventory lookup result.

Media typeapplication/json
object
click
required
object
app
required
object
id
required
Array<object>
object
count
required
number
value
required
string
device
required
object
type
required
Array<object>
object
count
required
number
value
required
string
location
required
object
city
required
Array<object>
object
count
required
number
value
required
string
country
required
Array<object>
object
count
required
number
value
required
string
locations
required
Array<object>
object
cities
required
Array<object>
object
count
required
number
value
required
string
latitude
number
longitude
number
country
required
string
total
required
number
total
required
number
user
required
object
id
required
Array<object>
object
count
required
number
value
required
string
impression
required
object
app
required
object
id
required
Array<object>
object
count
required
number
value
required
string
device
required
object
type
required
Array<object>
object
count
required
number
value
required
string
location
required
object
city
required
Array<object>
object
count
required
number
value
required
string
country
required
Array<object>
object
count
required
number
value
required
string
locations
required
Array<object>
object
cities
required
Array<object>
object
count
required
number
value
required
string
latitude
number
longitude
number
country
required
string
total
required
number
total
required
number
user
required
object
id
required
Array<object>
object
count
required
number
value
required
string

Example generated

{
"click": {
"app": {
"id": [
{
"count": 1,
"value": "example"
}
]
},
"device": {
"type": [
{
"count": 1,
"value": "example"
}
]
},
"location": {
"city": [
{
"count": 1,
"value": "example"
}
],
"country": [
{
"count": 1,
"value": "example"
}
]
},
"locations": [
{
"cities": [
{
"count": 1,
"value": "example",
"latitude": 1,
"longitude": 1
}
],
"country": "example",
"total": 1
}
],
"total": 1,
"user": {
"id": [
{
"count": 1,
"value": "example"
}
]
}
},
"impression": {
"app": {
"id": [
{
"count": 1,
"value": "example"
}
]
},
"device": {
"type": [
{
"count": 1,
"value": "example"
}
]
},
"location": {
"city": [
{
"count": 1,
"value": "example"
}
],
"country": [
{
"count": 1,
"value": "example"
}
]
},
"locations": [
{
"cities": [
{
"count": 1,
"value": "example",
"latitude": 1,
"longitude": 1
}
],
"country": "example",
"total": 1
}
],
"total": 1,
"user": {
"id": [
{
"count": 1,
"value": "example"
}
]
}
}
}

The JSON body is malformed or fails the input validation.

Media typeapplication/json
Any of:
object
errors
required

Zod issues

Array<object>
object
code
required
string
Allowed values: custom invalid_element invalid_format invalid_key invalid_type invalid_union invalid_value not_multiple_of too_big too_small unrecognized_keys
message
required
string
path
required

Location of the invalid field in the procedure input

Array
key
additional properties
message
required
string
Allowed value: Validation Error

Example

{
"errors": [
{
"code": "custom"
}
],
"message": "Validation Error"
}

The API key is missing, invalid, disabled or expired.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The API key lacks the scope, or its owner lacks the dashboard permission.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The API key exceeded its rate limit; retry after the Retry-After seconds.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}
Retry-After
integer

Seconds to wait before retrying.

Unexpected server error.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}