Skip to content

ECS Archetype

GET/api/v1/ecs/{index}/archetypes
GET
/api/v1/ecs/{index}/archetypes

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string

Query Parameters

filter?

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: entity_count, hash. Default: hash.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100
cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value
total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

application/json

curl -X GET "https://example.com/api/v1/ecs/string/archetypes"
{  "archetypes": [    {      "components": [        "string"      ],      "entity_count": 0,      "hash": "string"    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}
GET/api/v1/ecs/{index}/archetypes/{hash}
GET
/api/v1/ecs/{index}/archetypes/{hash}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

index*string
hash*string

Response Body

application/json

curl -X GET "https://example.com/api/v1/ecs/string/archetypes/string"
{  "components": [    "string"  ],  "entity_count": 0,  "hash": "string"}