Skip to main content
GET
/
reports
/
{report}
Retrieve a report
curl --request GET \
  --url https://api.chargeapi.co/v1/reports/{report} \
  --header 'Content-Type: application/json' \
  --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
}

Path Parameters

​
report
string
required

ID of the report to retrieve.

Query Parameters

​
expand
string[]

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

Body

application/json · object

Response

Returns the Report object for a valid identifier. If the report is still being generated, its status field is pending and url is null. When generation succeeds, status becomes succeeded, succeeded_at is populated, and url contains a downloadable link. Raises an error otherwise.

​
id
string

Unique identifier for the report object.

Example:

null

​
object
string

String representing the object’s type. Always reporting.

Example:

null

​
account
string

ID of the account associated with this report.

Example:

null

​
created
integer

Time at which the report was created.

Example:

null

​
fleet
string

ID of the fleet that this report is scoped to, if applicable.

Example:

null

​
parameters
object

Parameters used to generate the report.

​
size
integer

Size of the generated report file in bytes.

Example:

null

​
status
enum<string>

Current status of the report generation process.

Available options:
pending,
processing,
succeeded,
failed
Example:

null

​
succeeded_at
integer

Timestamp when the report generation was completed successfully.

Example:

null

​
type
string

File format of the generated report (e.g., csv, pdf).

Example:

null

​
url
string<uri>

Public URL to download the generated report file.

Example:

null