Skip to content

The calls made to sources, redacted, without bodies: a range of at most 31 days within the last 90 (the last 30 by default)

GET
/v1/buyer/calls
curl --request GET \
--url 'https://example.com/v1/buyer/calls?sort=started_at' \
--header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

from
string
to
string
connection_id
string
delivery_id
string
purpose
string
outcome
string

OK

Media typeapplication/json
object
data
required
Array<object>
object
attempt
required
integer format: int32
connection
required
object
id
required
integer format: int64
name
string
delivery_ids
required
Array<string>
duration_ms
required
integer format: int64
error_class
string | null
Allowed values: refused timeout too_large http network
id
required
string
message
required
string
method
required
string
outcome
required
string | null
Allowed values: ok retry failed partial auth_failed split forbidden
purpose
required
string | null
Allowed values: delivery cost_pull placement probe oauth test source_object login
remote_addr
required
string
request_body
required
string
request_body_truncated
required
boolean
request_headers
required
Array<object>
object
name
required
string
value
required
string
response_body
required
string
response_body_truncated
required
boolean
response_headers
required
Array<object>
object
name
required
string
value
required
string
started_at
required
string format: date-time
status
required
integer format: int32
template_id
required
string
template_version
required
integer format: int32
url
required
string
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example

{
"data": [
{
"error_class": "refused",
"outcome": "ok",
"purpose": "delivery"
}
]
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}