Skip to content

Export metrics as Excel

POST
/api/v1/analytics/export/xlsx
curl --request POST \
--url https://api.ultimateteam.ai/api/v1/analytics/export/xlsx \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "end_date": "example", "metric_ids": [ "example" ], "start_date": "example", "title": "Export" }'

Generate a branded Excel file from selected metrics.

Media typeapplication/json
AnalyticsExportRequest

Request body for analytics export endpoints.

Attributes: metric_ids: List of metric_id strings to export. start_date: Start date (YYYY-MM-DD). end_date: End date (YYYY-MM-DD). title: Optional export title.

object
end_date
required
End Date
string
metric_ids
required
Metric Ids
Array<string>
>= 1 items
start_date
required
Start Date
string
title
Title
string
default: Export

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}