Create an RTB group

POST

/api/v1/rtb-groups

curl --request POST \
  --url https://external-api.moja-ai.com/api/v1/rtb-groups \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "minimum_bid": 0, "ping_timeout": 5000, "predictive_routing_enabled": false, "predictive_routing_plan_id": "example", "minimum_call_count": 1, "desired_hours": 1, "underperforming_percentage": 1, "rtb_formulas": [ { "rtb_formula_id": "example", "maximum_bid_per_target": 0, "minimum_bid_per_target": 1, "ping_timeout_per_target": 1, "routing_modifier": 0, "routing_modifier_type": "percentage", "routing_modifier_value": 0 } ], "external_id": "example" }'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Header Parameters

X-API-Key

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

RTBGroupCreate

object

name

required

Name

string

>= 1 characters <= 255 characters

minimum_bid

Minimum Bid

number

0

ping_timeout

Ping Timeout

Ping timeout in milliseconds

integer

default: 5000 >= 1 <= 30000

predictive_routing_enabled

Predictive Routing Enabled

boolean

predictive_routing_plan_id

Any of:

string

string

>= 1 characters

null

null

minimum_call_count

Any of:

integer

integer

null

null

desired_hours

Any of:

integer

integer

>= 1

null

null

underperforming_percentage

Any of:

number

number

<= 100

null

null

rtb_formulas

required

Rtb Formulas

Array<object>

>= 1 items

RTBGroupFormulaInput

Input schema for RTB formula relationship when creating/updating an RTB group.

object

rtb_formula_id

required

Rtb Formula Id

string

>= 1 characters

maximum_bid_per_target

Maximum Bid Per Target

number

0

minimum_bid_per_target

Any of:

number

number

null

null

ping_timeout_per_target

Any of:

integer

integer

>= 1 <= 30000

null

null

routing_modifier

Routing Modifier

Legacy strategic routing modifier (-10..+10). Prefer routing_modifier_type/value for new clients.

integer

0 >= -10 <= 10

routing_modifier_type

Routing Modifier Type

How routing_modifier_value affects the predictive routing score. Routing-only; does not change payout.

string

default: percentage

Allowed values: percentage amount

routing_modifier_value

Routing Modifier Value

Thumb-on-scale value. percentage = relative percent points, amount = fixed dollar value added to score.

number

0 >= -1000 <= 1000

external_id

Any of:

string

string

>= 1 characters <= 64 characters

null

null

Responses

201

Successful Response

Media typeapplication/json

RTBGroupResponse

object

id

required

Id

string

created_at

Any of:

string

string format: date-time

null

null

updated_at

Any of:

string

string format: date-time

null

null

org_id

required

Org Id

string

name

required

Name

string

minimum_bid

required

Minimum Bid

number

ping_timeout

required

Ping Timeout

integer

predictive_routing_enabled

Predictive Routing Enabled

boolean

predictive_routing_plan_id

Any of:

string

string

null

null

minimum_call_count

Any of:

integer

integer

null

null

desired_hours

Any of:

integer

integer

null

null

underperforming_percentage

Any of:

number

number

null

null

rtb_formulas

Rtb Formulas

Array<object>

RTBGroupFormulaResponse

Response schema for RTB formula relationship.

object

id

required

Id

string

rtb_formula_id

required

Rtb Formula Id

string

rtb_formula

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

maximum_bid_per_target

required

Maximum Bid Per Target

number

minimum_bid_per_target

Any of:

number

number

null

null

ping_timeout_per_target

Any of:

integer

integer

null

null

routing_modifier

Routing Modifier

integer

0

routing_modifier_type

Routing Modifier Type

string

default: percentage

Allowed values: percentage amount

routing_modifier_value

Routing Modifier Value

number

0

external_id

Any of:

string

string

null

null

Example

{
  "predictive_routing_enabled": false,
  "rtb_formulas": [
    {
      "routing_modifier": 0,
      "routing_modifier_type": "percentage",
      "routing_modifier_value": 0
    }
  ]
}

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