101 lines
2.5 KiB
Markdown
101 lines
2.5 KiB
Markdown
---
|
|
name: events-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/events for the events route group.
|
|
---
|
|
|
|
# events API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/events for the events route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_events
|
|
|
|
- Operation ID: `get_events`
|
|
- Route: `GET /api/events`
|
|
- Mode: READ
|
|
- Summary: Get Events
|
|
- Parameters:
|
|
- `fields[attribution]` in `query`
|
|
- `fields[event]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `filter` in `query`
|
|
- `include` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_event
|
|
|
|
- Operation ID: `create_event`
|
|
- Route: `POST /api/events`
|
|
- Mode: WRITE
|
|
- Summary: Create Event
|
|
- Parameters:
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_event
|
|
|
|
- Operation ID: `get_event`
|
|
- Route: `GET /api/events/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Event
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[attribution]` in `query`
|
|
- `fields[event]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_metric_for_event
|
|
|
|
- Operation ID: `get_metric_for_event`
|
|
- Route: `GET /api/events/{id}/metric`
|
|
- Mode: READ
|
|
- Summary: Get Metric for Event
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[metric]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_metric_id_for_event
|
|
|
|
- Operation ID: `get_metric_id_for_event`
|
|
- Route: `GET /api/events/{id}/relationships/metric`
|
|
- Mode: READ
|
|
- Summary: Get Metric ID for Event
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_profile_for_event
|
|
|
|
- Operation ID: `get_profile_for_event`
|
|
- Route: `GET /api/events/{id}/profile`
|
|
- Mode: READ
|
|
- Summary: Get Profile for Event
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[profile]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_profile_id_for_event
|
|
|
|
- Operation ID: `get_profile_id_for_event`
|
|
- Route: `GET /api/events/{id}/relationships/profile`
|
|
- Mode: READ
|
|
- Summary: Get Profile ID for Event
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|