> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/analytics/reports.md).

# Reports

Business reports and data exports.

## POST /reports

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Reports","description":"Business reports and data exports."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReportDto":{"type":"object","properties":{"id":{"type":"string"},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string","description":"Required unless type=\"CUSTOMERS\"; for customers export see `usersFilters`."},"endDate":{"format":"date-time","type":"string","description":"Required unless type=\"CUSTOMERS\"; for customers export see `usersFilters`."},"areas":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"usersFilters":{"description":"For type=\"CUSTOMERS\" this is required and must mirror the Users listing filters (including `sort`).","allOf":[{"$ref":"#/components/schemas/CustomersExportUsersFiltersDto"}]},"type":{"type":"string","enum":["BALANCE_SUMMARY","BALANCE_ACTIVITY_SUMMARY","BALANCE_ACTIVITY_ITEMIZED","COACHING","CUSTOMERS","ORDERS","SETTLEMENTS"]},"status":{"type":"string","enum":["FAILED","CREATED","PENDING","SUCCEEDED","PROCESSING"],"readOnly":true},"url":{"type":"string","readOnly":true}},"required":["id","createdDate","areas","type","status","url"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"CustomersExportUsersFiltersDto":{"type":"object","properties":{"search":{"type":"string","description":"Free-text search (name, email, phone)"},"areas":{"description":"Areas to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"membershipAreas":{"description":"Membership areas to filter by (Members tab)","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"includePristine":{"type":"boolean","description":"Include pristine users when no explicit area selection"},"memberships":{"description":"Memberships to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"memberSinceMin":{"format":"date-time","type":"string","description":"Minimum membership enrollment date (inclusive)"},"memberSinceMax":{"format":"date-time","type":"string","description":"Maximum membership enrollment date (inclusive)"},"tenureMin":{"format":"date-time","type":"string","description":"Minimum account creation date (inclusive)"},"tenureMax":{"format":"date-time","type":"string","description":"Maximum account creation date (inclusive)"},"roles":{"description":"User roles to include","type":"array","items":{"type":"string"}},"conditions":{"type":"array","description":"Membership subscription conditions","items":{"type":"string","enum":["VALID","GRACE","HOLD"]}},"membershipStatuses":{"type":"array","description":"Extended membership statuses. Defaults to [\"ACTIVE\"] when exporting from the Members tab.","items":{"type":"string","enum":["ACTIVE","PENDING_CANCEL","CANCELLED","VALID","GRACE","HOLD"]}},"chargeTypes":{"type":"array","description":"Membership charge types","items":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"]}},"billingStatuses":{"type":"array","description":"High-level billing status (translated to subscription conditions server-side).","items":{"type":"string","enum":["ACTIVE","AT_RISK"]}},"sort":{"type":"string","description":"Sort string as used by Users listing (e.g., -fullName, memberSince, nextCharge)"}}}}},"paths":{"/reports":{"post":{"operationId":"ReportsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDto"}}}},"responses":{"201":{"description":"","content":{"application/csv":{"schema":{"$ref":"#/components/schemas/ReportDto"}}}}},"tags":["Reports"]}}}}
```

## GET /reports/{id}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Reports","description":"Business reports and data exports."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReportDto":{"type":"object","properties":{"id":{"type":"string"},"createdDate":{"format":"date-time","type":"string"},"startDate":{"format":"date-time","type":"string","description":"Required unless type=\"CUSTOMERS\"; for customers export see `usersFilters`."},"endDate":{"format":"date-time","type":"string","description":"Required unless type=\"CUSTOMERS\"; for customers export see `usersFilters`."},"areas":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"usersFilters":{"description":"For type=\"CUSTOMERS\" this is required and must mirror the Users listing filters (including `sort`).","allOf":[{"$ref":"#/components/schemas/CustomersExportUsersFiltersDto"}]},"type":{"type":"string","enum":["BALANCE_SUMMARY","BALANCE_ACTIVITY_SUMMARY","BALANCE_ACTIVITY_ITEMIZED","COACHING","CUSTOMERS","ORDERS","SETTLEMENTS"]},"status":{"type":"string","enum":["FAILED","CREATED","PENDING","SUCCEEDED","PROCESSING"],"readOnly":true},"url":{"type":"string","readOnly":true}},"required":["id","createdDate","areas","type","status","url"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"CustomersExportUsersFiltersDto":{"type":"object","properties":{"search":{"type":"string","description":"Free-text search (name, email, phone)"},"areas":{"description":"Areas to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"membershipAreas":{"description":"Membership areas to filter by (Members tab)","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"includePristine":{"type":"boolean","description":"Include pristine users when no explicit area selection"},"memberships":{"description":"Memberships to filter by","allOf":[{"$ref":"#/components/schemas/ItemRefCollectionDto"}]},"memberSinceMin":{"format":"date-time","type":"string","description":"Minimum membership enrollment date (inclusive)"},"memberSinceMax":{"format":"date-time","type":"string","description":"Maximum membership enrollment date (inclusive)"},"tenureMin":{"format":"date-time","type":"string","description":"Minimum account creation date (inclusive)"},"tenureMax":{"format":"date-time","type":"string","description":"Maximum account creation date (inclusive)"},"roles":{"description":"User roles to include","type":"array","items":{"type":"string"}},"conditions":{"type":"array","description":"Membership subscription conditions","items":{"type":"string","enum":["VALID","GRACE","HOLD"]}},"membershipStatuses":{"type":"array","description":"Extended membership statuses. Defaults to [\"ACTIVE\"] when exporting from the Members tab.","items":{"type":"string","enum":["ACTIVE","PENDING_CANCEL","CANCELLED","VALID","GRACE","HOLD"]}},"chargeTypes":{"type":"array","description":"Membership charge types","items":{"type":"string","enum":["FREE","MONTHLY","SIX_MONTHS","YEARLY","NON_RECURRING"]}},"billingStatuses":{"type":"array","description":"High-level billing status (translated to subscription conditions server-side).","items":{"type":"string","enum":["ACTIVE","AT_RISK"]}},"sort":{"type":"string","description":"Sort string as used by Users listing (e.g., -fullName, memberSince, nextCharge)"}}}}},"paths":{"/reports/{id}":{"get":{"operationId":"ReportsController_findById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `Report`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDto"}}}}},"tags":["Reports"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/analytics/reports.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.