Skip to content

Your workspace's own bot list

GET
/v1/buyer/bot-list
curl --request GET \
--url https://example.com/v1/buyer/bot-list \
--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.

OK

Media typeapplication/json
object
entries
required
Array<object>
object
added_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
connection
required
Any of:
object
id
required
integer format: int64
name
string
created_at
required
string format: date-time
id
required
integer format: int64
kind
required
string | null
Allowed values: ip network asn user_agent placement
note
required
string
value
required
string
sequence
required
integer format: int64
updated_at
required
string | null format: date-time
workspace_id
required
integer format: int64

Example

{
"entries": [
{
"added_by": {
"kind": "user"
},
"kind": "ip"
}
]
}

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"
}
}