Export metrics as PDF

POST

/api/v1/analytics/export/pdf

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

• Production
• Local development

Generate a branded PDF from selected metrics.

Authorizations

• ApiKeyAuth

Request Body^required

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

Responses

200

Successful Response

Media typeapplication/json

Example^generated

example

422

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

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}