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

# Reports

## Get usage report summary

> Gets a usage summary of all sessions for your account, including the number of sessions and their durations. Query parameters can be used for fine-tuned reports.

```json
{"openapi":"3.0.3","info":{"title":"Appetize V2 API Reference","version":"2"},"servers":[{"url":"https://api.appetize.io"}],"security":[{"jwt":[]},{"apiToken":[]}],"components":{"securitySchemes":{"apiToken":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Use an API token for authentication via X-API-KEY header"}},"schemas":{"Error":{"type":"object","properties":{"message":{"description":"Error message.","type":"string"}}}}},"paths":{"/v2/reports/usage/summary":{"get":{"tags":["Reports"],"summary":"Get usage report summary","description":"Gets a usage summary of all sessions for your account, including the number of sessions and their durations. Query parameters can be used for fine-tuned reports.","parameters":[{"name":"groupByDate","in":"query","description":"Group sessions with a certain date range. You can also group by a custom number of days by passing `${int}d`.","required":true,"schema":{"type":"string","enum":["day","week","month","all","${int}d"]}},{"name":"dateAnchor","in":"query","description":"Must only be included if using a custom groupByDate number. Anchors the groupByDate to a custom UTC date.","required":false,"schema":{"type":"string","format":"date"}},{"name":"buildId","in":"query","description":"If set, only sessions for the given buildId will be included in the report.","required":false,"schema":{"type":"string","default":"all"}},{"name":"startDate","in":"query","description":"The start date of the report (UTC time & inclusive).","required":false,"schema":{"type":"string","format":"date","default":"12 months prior to today"}},{"name":"endDate","in":"query","description":"The end date of the report (UTC time & inclusive).","required":false,"schema":{"type":"string","format":"date","default":"today"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["startDate","endDate","numSessions","minutes"],"properties":{"startDate":{"description":"Start date of this session grouping.","type":"string","format":"date"},"endDate":{"description":"End date of this session grouping.","type":"string","format":"date"},"buildId":{"description":"BuildId of the grouped sessions. Alternatively the standalone or app group id.","type":"string"},"numSessions":{"description":"Number of grouped sessions.","type":"number"},"minutes":{"description":"Sum of minutes from the grouped sessions.","type":"number"},"platform":{"description":"Platform used for the grouped sessions.","type":"string","enum":["ios","android"]},"name_latest":{"description":"Name of app or app group if the grouping was performed on an app or app group.","type":"string"},"appId_latest":{"description":"appId if the grouping was performed on an app.","type":"string"},"note_latest":{"description":"Note on the app or app group.","type":"string"},"day":{"description":"Date of the grouping. Included when groupByDate=day.","type":"string","format":"date"},"week":{"description":"Week of the grouping. Included when groupByDate=week.","type":"string"},"month":{"description":"Month of the grouping. Included when groupByDate=month.","type":"string","format":"date"}}}}}}},"text/csv":{"schema":{"type":"string","description":"Same properties as the JSON response, only in csv format."}}}},"400":{"description":"Invalid query parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"406":{"description":"Unsupported Accept header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Get report on concurrent usage

> Gets the maximum number of concurrent sessions over time periods. Query parameters can be used for fine-tuned reports.

```json
{"openapi":"3.0.3","info":{"title":"Appetize V2 API Reference","version":"2"},"servers":[{"url":"https://api.appetize.io"}],"security":[{"jwt":[]},{"apiToken":[]}],"components":{"securitySchemes":{"apiToken":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Use an API token for authentication via X-API-KEY header"}},"schemas":{"Error":{"type":"object","properties":{"message":{"description":"Error message.","type":"string"}}}}},"paths":{"/v2/reports/usage/concurrency":{"get":{"tags":["Reports"],"summary":"Get report on concurrent usage","description":"Gets the maximum number of concurrent sessions over time periods. Query parameters can be used for fine-tuned reports.","parameters":[{"name":"platform","in":"query","description":"If set, only sessions for the given platform will be included in the report.","required":false,"schema":{"type":"string","default":"both","enum":["ios","android","both"]}},{"name":"startDate","in":"query","description":"The start date of the report (UTC time & inclusive).","required":false,"schema":{"type":"string","format":"date","default":"3 months prior to today"}},{"name":"endDate","in":"query","description":"The end date of the report (UTC time & inclusive).","required":false,"schema":{"type":"string","format":"date","default":"today"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["maxConcurrent","startDate","endDate"],"properties":{"startDate":{"description":"Start date of this session grouping.","type":"string","format":"date"},"endDate":{"description":"End date of this session grouping.","type":"string","format":"date"},"maxConcurrent":{"description":"Maximum number of concurrent sessions in this period.","type":"number"},"platform":{"description":"Platform that the sessions were ran on.","type":"string","enum":["ios","android"]}}}}}}},"text/csv":{"schema":{"type":"string","description":"Same properties as the JSON response, only in csv format."}}}},"400":{"description":"Invalid query parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"406":{"description":"Unsupported Accept header","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Get report on accounts

> Gets a report containing useful information about an account. E.g. the number of users associated with it

```json
{"openapi":"3.0.3","info":{"title":"Appetize V2 API Reference","version":"2"},"servers":[{"url":"https://api.appetize.io"}],"security":[{"jwt":[]},{"apiToken":[]}],"components":{"securitySchemes":{"apiToken":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Use an API token for authentication via X-API-KEY header"}}},"paths":{"/v2/reports/accounts":{"get":{"tags":["Reports"],"summary":"Get report on accounts","description":"Gets a report containing useful information about an account. E.g. the number of users associated with it","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["numUsers"],"properties":{"numUsers":{"description":"Number of users associated with the account.","type":"number"}}}}}}}}}}}
```