Chart

Retrieves a list of Charts.

GET/api/charts

Retrieves a list of Charts.

curl --request GET \
  --url 'https://app.output.rocks/api/charts?page=1&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5Bwidth%5D=asc&order%5Bheight%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "identifier": "key1",
    "active": true,
    "activeFrom": "2024-01-01"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[identifier]

stringdefault:asc

No description provided.

order[width]

stringdefault:asc

No description provided.

order[height]

stringdefault:asc

No description provided.

order[activeFrom]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

brandIdentifier

string

No description provided.

brandIdentifier[]

string[]

No description provided.

identifier

string

No description provided.

string

Search across multiple fields (id, identifier, brandIdentifier, width, height, bgColor, chartJsVersion, activeFrom, active, subClientDefault, createdAt, updatedAt, subClient.description) using OR logic with partial matching.

active

boolean

No description provided.

activeFrom[before]

string

No description provided.

activeFrom[strictly_before]

string

No description provided.

activeFrom[after]

string

No description provided.

activeFrom[strictly_after]

string

No description provided.

Response

200application/json

Chart collection

integer

Identifier generated by Output.Rocks.

Example: 12345

identifier

stringrequired

Unique identifier

Example: "key1"

active

boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom

string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"