GET
/
reports
curl --request GET \
  --url https://api.chargeapi.co/v1/reports \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "object": "list",
  "url": "<string>",
  "has_more": true,
  "data": [
    {
      "id": null,
      "object": null,
      "account": null,
      "created": null,
      "fleet": null,
      "parameters": {
        "filters": {
          "vehicle": null
        },
        "group_by": null,
        "period_start": null,
        "period_end": null,
        "type": null
      },
      "size": null,
      "status": null,
      "succeeded_at": null,
      "type": null,
      "url": null
    }
  ]
}

Query Parameters

limit
integer

Maximum number of reports to return (default 10).

Required range: 1 <= x <= 100
starting_after
string

Cursor for pagination; returns items after this report ID.

ending_before
string

Cursor for pagination; returns items before this report ID.

status
enum<string>

Filter results by report status.

Available options:
pending,
succeeded,
failed
expand
string[]

Specifies related objects to expand in each report (for example, expand[]=fleet).

Body

application/json · object

Response

200
application/json

A dictionary with a data property that contains an array of up to limit Report objects, starting after Report starting_after. Each entry in data is a separate Report object. If no additional reports are available, the array is empty.

The response is of type object.