Docs
Get Area Dashboard
GET /Areas/{areaId}/dashboard
GET
/Areas/{areaId}/dashboardRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
| Area token | x-Area-Token | Optional | Run **Get Tokens** with `areaId` set in your environment, or call `GET /Areas/{areaId}/authorize` with your event token. |
Returns a summary of activities associated with this area. Useful for building a quick overview of what is scheduled for the area.
Requires EventAdmin permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| areaId | Guid | Required | The ID of the area. |
Response
| Field | Type | Description |
|---|---|---|
| activities | array | List of activities associated with this area. |
Activity Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Activity ID. |
| name | string | Activity name. |
| startDateTime | DateTime | Activity start time (UTC). |
| endDateTime | DateTime | Activity end time (UTC). |