Summarise entries

GET

/v1/game-instances/{campaignId}/entries/summary

curl --request GET \
  --url https://api.keliplay.com/v1/game-instances/example/entries/summary \
  --header 'Authorization: Bearer <token>'

• Production

Counts the campaign’s entries across all pages. For a prediction campaign, byOption counts the eligible entries that backed each option.

Permission: results.read.

Authorizations

• apiKey

Parameters

Path Parameters

campaignId

required

string

The campaign’s id.

Responses

200

The counts.

Media typeapplication/json

object

total

required

integer

eligible

required

integer

byOption

required

Array<object>

object

optionId

required

string

count

required

integer

Example

{
  "total": 412,
  "eligible": 398,
  "byOption": [
    {
      "optionId": "home-win",
      "count": 211
    },
    {
      "optionId": "draw",
      "count": 187
    }
  ]
}

401

The API key is missing, malformed or revoked.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}

403

The API key does not carry the permission this needs, or the request is not allowed.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "forbidden",
    "message": "Your role does not allow this (draws.run)."
  }
}

404

Nothing with that id exists in your account.

Media typeapplication/json

object

error

required

object

code

required

Stable and safe to branch on.

• invalid_request (400): the request is not valid.
• unauthorized (401): missing, malformed or revoked API key.
• upgrade_required (402): not in your plan, or a plan limit is reached.
• forbidden (403): the key lacks a permission, or the action is not allowed.
• not_found (404): nothing with that id in your account.
• conflict (409): clashes with the current state.
• confirmation_required (409): repeat with confirm=true. Folder deletion only.
• rate_limited (429): wait for Retry-After seconds.
• internal_error (500) and service_unavailable (503): try again later.

string

Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable

message

required

Written for a person. May change; do not parse it.

string

details

One of:

Array<object>

Array<object>

object

path

required

The failing field, dot separated, such as prize.label.

string

message

required

string

object

object

key

additional properties

any

Example

{
  "error": {
    "code": "not_found",
    "message": "Channel 0192f3a1-0000-7000-8000-00000000c009 not found."
  }
}