List All Reports for the Organization endpoint provides access to a comprehensive list of reports associated with the organization. This endpoint supports pagination, ensuring efficient retrieval of reports and associated data in manageable chunks. For more detailed information on report types, please refer to the documentation here.

¶ Use case

Initiate a request to this endpoint by providing the organization’s ID as a parameter. The API processes and returns paginated content containing details such as file names, report type, statuses, and other relevant information. Additionally, the results are sorted based on created time in descending order.

¶ Using Dependent API

To efficiently retrieve a comprehensive list of reports for an organization of Fleet or Rental partners, they should follow a two-step process. Firstly, they must use the Get Organizations API to obtain the encrypted IDs of all child organizations associated with the primary organization. Secondly, with these encrypted organization IDs, owners can then utilize the List All Reports For The Organization endpoint. For obtaining the primary organization’s encrypted UUID, please reach out to the support team.

¶ Supported supplier types

Rental/Fleets

¶ Scopes

Primary - solutions.suppliers.reports

¶ Resource

v1/vehicle-suppliers/suppliers/:org_id/reports?page_token=<page_token>&page_size=<page_size>

¶ HTTP Method

GET

¶ Authorization

Client Credentials

¶ Example Request

curl --location 'https://api.uber.com/v1/vehicle-suppliers/suppliers/<org_id>/reports?page_token=<page_token>&page_size=<page_size> \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \

¶ Example Response

{
  "reports": [
    {
      "id": "dsuirhwiuhrfbryrurptpt",
      "fileName": "abcs.csv",
      "orgId": "qoiewoifpwionfwoinwovmow4ivmp",
      "reportType": "REPORT_TYPE_DRIVER_QUALITY",
      "startTime": "2023-03-30T00:13:55.926Z",
      "endTime": "2023-03-30T00:13:55.926Z",
      "status": "REPORT_STATUS_IN_PROGRESS",
      "failedReason": "REPORT_GENERATION_FAILED_REASON_NONE",
      "createdAt": "2023-06-30T00:13:55.926Z",
      "updatedAt": "2023-06-30T00:13:55.926Z",
      "completedAt": "2023-06-30T00:13:58.926Z"
    }
  ],
  "paginationResult": {
    "nextPageToken": ""
  }
}

¶ Request Path Parameters

Name	Type	Required	Description
org_id	string	Y	Encrypted organization UUID.

¶ Request Query Parameters

Name	Type	Required	Description
page_token	string	N	Represents the cursor from where the next set of results have to be fetched.
page_size	int32	Y	Number of maximum results needed in the output.

¶ Response Fields

Name	Type	Description
report	Array of Report	Report entity.
paginationResult	Object of PaginationResult	Pagination result for next pages.

¶ Response Entities

PaginationResult

Name	Type	Description
nextPageToken	string	Can be blank, if there are no more records.

Report

Name	type	Description
id	string	This is the report id.
fileName	string	This is the file name for requested report.
orgId	string	This is organization id (obfuscated).
reportType	string	Represents the type of the report ReportType.
startTime	string	ISO UTC time format for example 2023-03-30T00:13:55.926Z.
endTime	string	ISO UTC time format for example 2023-03-30T00:13:55.926Z.
status	string	Represents the generation status of the report ReportStatus.
failedReason	string	One of the values in FailedReason.
createdAt	string	ISO UTC time format for example 2023-03-30T00:13:55.926Z.
updatedAt	string	ISO UTC time format for example 2023-03-30T00:13:55.926Z.
completedAt	string	ISO UTC time format for example 2023-03-30T00:13:55.926Z, represents the time when the report generation was completed.

ReportType

Name	Description
REPORT_TYPE_ORGANIZATION	List of organizations.
REPORT_TYPE_PAYMENTS_ORDER	Report ‌that has payment information for orders.
REPORT_TYPE_PAYMENTS_DRIVER	Report having payment information for the driver.
REPORT_TYPE_PAYMENTS_ORGANIZATION	Report payment information for the organization.
REPORT_TYPE_DRIVER_QUALITY	Report having driver quality-related information.
REPORT_TYPE_DRIVER_ACTIVITY	Report having driver activity-related information.
REPORT_TYPE_TRIP_ACTIVITY	Report having trips related information.
REPORT_TYPE_DRIVER_STATUS	Report having driver realtime status and onboarding status related information.
REPORT_TYPE_DRIVER	Report having driver information.
REPORT_TYPE_TRIP	Report that has trip information.
REPORT_TYPE_VEHICLE_PERFORMANCE	Report having vehicle performance-related information.
REPORT_TYPE_DRIVER_PERFORMANCE	Report having driver performance-related information.
REPORT_TYPE_BACKFILL_REALTIME_DRIVER_STATUS_CHANGE_WEBHOOK_EVENTS	Report containing failed delivery events for REALTIME_DRIVER_STATUS_CHANGE webhook.
REPORT_TYPE_RENTAL_PAYMENTS_TRANSACTION	A report consisting of transactions occurring within a rental organization.
REPORT_TYPE_RENTAL_PAYMENTS_CONTRACT	Report consisting of aggregated payments for rental organization, with one row per contract.
REPORT_TYPE_RENTAL_PAYMENTS_ORGANIZATION	Report consisting of transactions summary at organization level.

ReportStatus

Name	Description
REPORT_STATUS_COMPLETED	Report generation is completed.
REPORT_STATUS_FAILED	Report generation failed due to some issue.
REPORT_STATUS_IN_PROGRESS	Report generation is in progress.

FailedReason

Name	Description
REPORT_GENERATION_FAILED_REASON_INTERNAL_SERVER_ERROR	Failed due to some internal error.
REPORT_GENERATION_FAILED_REASON_NONE	No failure occured.

¶ Rate Limit

• Rate limit for this endpoint is 100 requests per 10 minutes per Developer Application.

¶ Endpoint Specific Errors

Http Status Code	Code	Message
400	bad_request	The request parameters are invalid.
500	internal_server_error	Internal server error.
403	unauthenticated	User does not have permission.
429	rate_limited	Number of requests exceeds allowed limit.
503	service_unavailable	Service unavailable.
401	unauthorized	Invalid OAuth 2.0 credentials.