Find where files are used

GET

/v1/tenant/assets/usage

curl --request GET \
  --url 'https://api.keliplay.com/v1/tenant/assets/usage?ids=0192f3a1-0000-7000-8000-0000000f2001' \
  --header 'Authorization: Bearer <token>'

• Production

For each file, lists the campaigns, channels and branding that use it, so you can check before deleting. Up to 25 places are listed per file; total gives the full count.

Permissions: assets.read and campaigns.read.

Authorizations

• apiKey

Parameters

Query Parameters

ids

required

string

Comma-separated file ids, up to 50.

Example

0192f3a1-0000-7000-8000-0000000f2001

Responses

200

Where each file is used.

Media typeapplication/json

object

usage

required

Array<object>

object

assetId

required

string

total

required

integer

references

required

Array<object>

<= 25 items

object

kind

required

string

Allowed values: campaign channel branding

id

required

The campaign or channel id. Null for branding.

string | null

name

required

string | null

field

required

string

Allowed values: config theme betweenCampaigns

Example

{
  "usage": [
    {
      "assetId": "0192f3a1-0000-7000-8000-0000000f2001",
      "total": 2,
      "references": [
        {
          "kind": "campaign",
          "id": "0192f3a1-0000-7000-8000-0000000ca001",
          "name": "Autumn wheel",
          "field": "config"
        },
        {
          "kind": "branding",
          "id": null,
          "name": null,
          "field": "theme"
        }
      ]
    }
  ]
}

400

The request is not valid. details lists each field that failed, where there is one.

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": "invalid_request",
    "message": "Invalid request json.",
    "details": [
      {
        "path": "name",
        "message": "Too small, expected string to have >=1 characters"
      }
    ]
  }
}

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