Get the account overview

GET

/v1/tenant/overview

const url = 'https://api.keliplay.com/v1/tenant/overview';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.keliplay.com/v1/tenant/overview \
  --header 'Authorization: Bearer <token>'

Returns headline numbers: campaigns by status, plays over the last 14 days, the five most recent winners, webhook deliveries in the last 24 hours, and plays per campaign.

Permission: campaigns.read.

Authorizations

apiKey

Responses

200

The overview.

application/json

object

campaigns

required

object

total

required

integer

active

required

integer

draft

required

integer

paused

required

integer

archived

required

integer

plays

required

object

total

required

integer

lastWeek

required

Plays in the last 7 days of the trend.

integer

previousWeek

required

Plays in the 7 days before that.

integer

daily

required

Plays per day for the last 14 days, oldest first.

Array<object>

object

date

required

string format: date

plays

required

integer

winners

required

object

total

required

integer

recent

required

Array<object>

<= 5 items

object

required

string

participantRef

required

string

rank

required

integer

createdAt

required

string format: date-time

campaignId

required

string

campaignName

required

string

channelId

required

string

webhooks

required

object

last24h

required

object

total

required

integer

success

required

integer

failed

required

Failed and exhausted deliveries together.

integer

pending

required

integer

playsByCampaign

required

Array<object>

object

gameInstanceId

required

string

plays

required

integer

Example

{
  "campaigns": {
    "total": 6,
    "active": 2,
    "draft": 2,
    "paused": 0,
    "archived": 2
  },
  "plays": {
    "total": 5120,
    "lastWeek": 840,
    "previousWeek": 760,
    "daily": [
      {
        "date": "2026-10-04",
        "plays": 118
      },
      {
        "date": "2026-10-05",
        "plays": 96
      }
    ]
  },
  "winners": {
    "total": 14,
    "recent": [
      {
        "id": "0192f3a1-0000-7000-8000-0000000e0001",
        "participantRef": "user_48213",
        "rank": 1,
        "createdAt": "2026-09-30T18:00:01.000Z",
        "campaignId": "0192f3a1-0000-7000-8000-0000000ca001",
        "campaignName": "Autumn wheel",
        "channelId": "0192f3a1-0000-7000-8000-00000000c001"
      }
    ]
  },
  "webhooks": {
    "last24h": {
      "total": 120,
      "success": 118,
      "failed": 1,
      "pending": 1
    }
  },
  "playsByCampaign": [
    {
      "gameInstanceId": "0192f3a1-0000-7000-8000-0000000ca001",
      "plays": 3200
    }
  ]
}

401

The API key is missing, malformed or revoked.

application/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>
object

Array<object>

object

path

required

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

string

message

required

string

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.

application/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>
object

Array<object>

object

path

required

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

string

message

required

string

Example

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