Skip to content

Accumulate

GET /accumulate

Accumulate

Requires an admin, backend, or broadcaster JWT.

Authorization

Send Authorization: <Twitch Extension Client ID> <Muxy JWT>. The JWT role must satisfy the endpoint requirements shown in the examples.

Parameters

Name In Required Type Constraints Description
id query no string default "default" The name of the accumulation buffer from which to retrieve data.
start query no integer default 0 Unix millisecond timestamp of earliest entry to include in the result.

Responses

200 Response

200

Content type: application/json

Schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "observed": {
            "type": "integer",
            "example": 1634401498121,
            "default": 0
          },
          "channel_id": {
            "type": "string",
            "example": "12345"
          },
          "opaque_user_id": {
            "type": "string",
            "example": "U12345"
          },
          "user_id": {
            "type": "string",
            "example": "12345"
          },
          "data": {
            "type": "object",
            "properties": {}
          }
        }
      }
    },
    "latest": {
      "type": "integer",
      "example": 1634401498121,
      "default": 0
    }
  }
}
Example
{
  "data": [
    {
      "observed": 1634401498121,
      "channel_id": "12345",
      "opaque_user_id": "U12345",
      "user_id": "",
      "data": {
        "next_game": "Day of the Tentacle"
      }
    }
  ],
  "latest": 1634401498121
}

400 Error

400

Content type: application/json

Schema
{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string"
    }
  }
}
Example
{
  "reason": "400"
}

403 Error

The JWT role is not allowed to perform this operation.

Content type: application/json

Schema
{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string"
    }
  }
}
Example
{
  "reason": "The JWT role is not allowed to perform this operation."
}

Examples

Curl

curl --request GET \
  --url https://api.muxy.io/v1/e/accumulate \
  --header 'authorization: <Client ID> <broadcaster, admin, or backend JWT>' \
  --header 'content-type: application/json'

Generated API reference

This endpoint is generated from rest-v1.yaml.