Kaiten
Instances

Get entitlement usage metrics for an instance

Retrieve the usage metrics for a specific entitlement in a given instance

GET
/instances/{instanceSlug}/entitlements/{entitlementSlug}/usage

Path Parameters

instanceSlug*string

Instance slug

entitlementSlug*string

Entitlement slug

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://demo.kaiten.sh/instances/instance-slug/entitlements/entitlement-slug/usage"
{
  "behavior": "append",
  "entitlementId": "123e4567-e89b-12d3-a456-426614174000",
  "entitlementSlug": "premium-support",
  "licenseId": "123e4567-e89b-12d3-a456-426614174001",
  "licenseSlug": "enterprise-license",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "timestamp": "2023-10-01T12:00:00Z",
  "value": {
    "event_count": 2,
    "type": "number",
    "value": 42.5
  }
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

List all entitlements usage metrics

Retrieve a list of all entitlements usage metrics for a specific instance

Report entitlement usage metric for an instance

Report a usage metric for a specific entitlement in a given instance. This endpoint allows you to report the usage of an entitlement, including optional metadata and a timestamp.