List inbound RTBs

GET

/api/v1/inbound-rtb

curl --request GET \
  --url 'https://external-api.moja-ai.com/api/v1/inbound-rtb?limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Query Parameters

limit

Limit

integer

default: 20 >= 1 <= 200

offset

Offset

integer

0

campaign_id

Any of:

string

string

null

null

publisher_id

Any of:

string

string

null

null

Header Parameters

X-API-Key

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

InboundRtbListResponse

object

data

required

Data

Array<object>

InboundRtbResponse

object

id

required

Id

integer

inbound_rtb_id

required

Inbound Rtb Id

string

campaign_id

required

Campaign Id

string

campaign_name

Any of:

string

string

null

null

publisher_id

required

Publisher Id

string

publisher_name

Any of:

string

string

null

null

payout_mode

required

Payout Mode

string

payout_percentage

Any of:

number

number

null

null

duration_add_seconds

Any of:

integer

integer

null

null

payout

Any of:

number

number

null

null

payout_condition

Any of:

string

string

null

null

payout_condition_duration

Any of:

integer

integer

null

null

allocation_time_seconds

required

Allocation Time Seconds

integer

rate_limit

required

Rate Limit

integer

rate_period

required

Rate Period

string

is_active

required

Is Active

boolean

receive_mode

Receive Mode

string

default: dynamic

receive_number_id

Any of:

string

string

null

null

external_id

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

updated_at

Any of:

string

string format: date-time

null

null

meta

required

PaginatedResponseMeta

object

limit

required

Limit

integer

offset

required

Offset

integer

count

required

Count

integer

total

required

Total

integer

has_more

required

Has More

boolean

next_offset

Any of:

integer

integer

null

null

previous_offset

Any of:

integer

integer

null

null

Example

{
  "data": [
    {
      "receive_mode": "dynamic"
    }
  ]
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}