Skip to content

List targets and RTB formulas reachable from a campaign that can be paused

GET
/api/v1/campaigns/{campaign_id}/pausable-entities
curl --request GET \
--url https://external-api.moja-ai.com/api/v1/campaigns/example/pausable-entities \
--header 'X-API-Key: <X-API-Key>'
campaign_id
required
Campaign Id
string
X-API-Key
Any of:
string

Successful Response

Media typeapplication/json
PausableEntitiesResponse
object
entities
required
Entities
Array<object>
PausableEntity
object
type
required
Type
string
Allowed values: target rtb
id
required
Id
string
name
required
Name
string
is_active
required
Is Active
boolean
is_paused
required
Is Paused
boolean
paused_until
Any of:
string format: date-time
Example
{
"entities": [
{
"type": "target"
}
]
}

Bad Request

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Unauthorized

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Not Found

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Conflict

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}

Too Many Requests

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
"detail": {
"code": "example",
"message": "example"
}
}