69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
---
|
|
name: reporting-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v1/reporting for the reporting route group.
|
|
---
|
|
|
|
# reporting API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v1/reporting for the reporting 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_reporting_report_runs
|
|
|
|
- Operation ID: `get_reporting_report_runs`
|
|
- Route: `GET /v1/reporting/report_runs`
|
|
- Mode: READ
|
|
- Summary: List all Report Runs
|
|
- Parameters:
|
|
- `created` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_reporting_report_runs
|
|
|
|
- Operation ID: `post_reporting_report_runs`
|
|
- Route: `POST /v1/reporting/report_runs`
|
|
- Mode: WRITE
|
|
- Summary: Create a Report Run
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_reporting_report_runs_report_run
|
|
|
|
- Operation ID: `get_reporting_report_runs_report_run`
|
|
- Route: `GET /v1/reporting/report_runs/{report_run}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Report Run
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `report_run` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_reporting_report_types
|
|
|
|
- Operation ID: `get_reporting_report_types`
|
|
- Route: `GET /v1/reporting/report_types`
|
|
- Mode: READ
|
|
- Summary: List all Report Types
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_reporting_report_types_report_type
|
|
|
|
- Operation ID: `get_reporting_report_types_report_type`
|
|
- Route: `GET /v1/reporting/report_types/{report_type}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a Report Type
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `report_type` in `path` required
|
|
- Body: JSON request body accepted.
|