The Report API allows you to manage reports, including creating, retrieving, listing, deleting, and downloading the files from them. After initiating a report, you can pull the API to check its status until the report is complete. Once finalized, all related files can be downloaded.

To run report periodically pass the interval query parameters in minutes, the report will run every specified interval starting at the time of creation, next run will be time of report completion plus the interval in minutes. Each run will produce a file that is inserted at the beginning of the files list, up to 6 files currently supported only but may be increased in the future. More exact schedule times will be added soon.

Reports expire after 60 days since last completion, scheduled reports may be kept indefinitely if they keep running.

An alternative to polling a webhook REPORT_CREATED is sent if configured about every generated report, see [Webhooks)[webhooks] section for more details.

For details on the different report types, see Report Types.

• cid - Your organization ID
• rpid - The report unique ID
• report - The original report title submitted, immutable.
• title - The title of the report, same as original but can be changed after run to be more friendly.
• email - The email address that will get report notifications.
• update_time - The modification time of the report in human date-time format.
• create_time - The creation time of the report in human date-time format.
• interval - If provided during creation indicates how frequently this report runs in minutes, for scheduled reports.
• requested_by - An object containing details about the user who created the report.
  • name - The name of the user, “api” if created via API.
  • id - The unique identifier for the user, “api” if created via API.
• query - An object for storing any query parameters or filters used to generate the report.
• status - The current status of the report:
  • running - the report is currently running
  • scheduled - the report is scheduled to be run in the future, i.e. interval was provided
  • done - indicating that the report is completed
  • error - an error occurred
• error - in case of an error this will contain details
• files - An array of objects, each representing a file associated with the report.
  • id - The unique file number.
  • file - The unique identifier for the file.
  • create_time - The time this file was created in in human date-time format.
  • name - The display name of the file, optional.
  • size - The size of the file in bytes.
  • count - The number of items or records within the file.
  • ext - The file extension, indicating the file format, “csv” for a comma-separated values file, “zip” for zipped CSV files.
  • url - The URL to download the file, this can be used directly in the download API
  • ctime - The time this file was created in milliseconds. (Deprecated)

Deprecated properties still provided for compatibility:

• account - a user who requested the report (Deprecated)
• mtime - The modification time of the report in milliseconds.(Deprecated)
• ctime - The creation time of the report in milliseconds. (Deprecated)

Example Object

{
  "cid": "c_8abe4338801714749b9df6c2",
  "rpid": "bb3227929fb44f579757623d2d0e60fc",
  "report": "ProjectStats",
  "title": "ProjectStats 07/20/2025 11:38am CDT- 07/27/2025 11:38am CDT",
  "status": "done",
  "interval": 0,
  "requested_by": {
    "id": "api",
    "name": "api"
  },
  "query": {
    "days": "7"
  },
  "files": [
    {
      "id": 1,
      "file": "68be0ca917904f40b06160a109d71444",
      "name": "ProjectStats 07/20/2025 11:38am CDT- 07/27/2025 11:38am CDT",
      "size": 1915,
      "count": 4,
      "ext": "csv",
      "ctime": 1753630727606,
      "url": "/api/report/download/bb3227929fb44f579757623d2d0e60fc/1",
      "create_time": "07/27/2025 11:38am CDT"
    }
  ],
  "create_time": "07/27/2025 11:38am CDT",
  "update_time": "07/27/2025 11:38am CDT",
  "account": {
    "id": "api",
    "name": "api"
  },
  "ctime": 1753630726743,
  "mtime": 1753630727605
}  

• Endpoint: /api/report/create

• Method: POST

• Description: Create a new report.

• Request Body Parameters:

  • title (String, Required) - The title or name of the report, see Report Types for specific type;
  • interval (Integer, Optional) - To make the report scheduled, i.e. run periodically this can be passed as minutes, for example passing 30 means run report every 30 mins and add files to the list. Only 5 recent files are kept.
  • .... - any additional parameters per specific report type

• Response:
  Success: Returns a report object.

  Error: Returns an appropriate error message when validation fails in the common format explained in General Overview

• Specific Errors
  If not marked as retry-able errors returned by this endpoint are final, no report has been created.

  Error codes:

  • 400
    An input field validation error details in the message

• Endpoint: /api/report/get/{rpid}

• Method: GET

• Description: Check the status of a report by its ID.

• Request Path Parameters:
  {rpid} - Unique identifier for the report.

• Response:
  Success: Returns a report object.

  Error: Returns an appropriate error message when validation fails in the common format explained in General Overview

• Specific Errors
  If not marked as retry-able errors returned by this endpoint are final, no report has been created.

  Error codes:

  • 400
    Parameters provided are missing or invalid
  • 404
    Report id is invalid or does not exist
  • 403
    Access to the specified report denied, the report was created with more strict permissions

• Endpoint: /api/report/download/{rpid}/{fileid}

• Method: GET

• Description: Download a file from a completed report by file ID.

• Request Path Parameters:

• {rpid}: - The report id, rpid` property from the report object.

• {fileid}: The numeric id of the file to download or latest to download the most recent file in case of periodic report that produces multiple files.

• Response:
  Success: Returns a report file contents.

  Error: Returns an appropriate error message when validation fails in the common format explained in General Overview

• Specific Errors
  Error codes:

  • 400
    Parameters provided are missing or invalid
  • 404
    Report id is invalid or does not exist
  • 403
    Access to the specified report denied, the report was created with more strict permissions

• Endpoint: /api/report/list

• Method: GET

• Description: Retrieve a list of all available reports.

• Request Body Parameters:
  ** None

• Response:
  Success: Returns a list of report objects.

  Error: Returns an appropriate error message when validation fails in the common format explained in General Overview

Example Request:

curl -u CID:KEY https://app.rumbleup.com/api/report/list

Example Response:

{
  "count": 3,
  "data": [
    {
      "cid": "c_8abe4338801714749b9df6c2",
      "rpid": "13aa949cf5594052b8dc9dad999a8173",
      "report": "Project Stats",
      "title": "Project Stats 07/26/2025 12:26pm CDT- 07/27/2025 12:26pm CDT",
      "status": "scheduled",
      "interval": 15,
      "requested_by": {
        "id": "api",
        "name": "api"
      },
      "query": {},
      "files": [
        {
          "id": 2,
          "file": "",
          "name": "Project Stats 07/26/2025 01:00pm CDT- 07/27/2025 01:00pm CDT",
          "size": 0,
          "count": 0,
          "ctime": 1753635624975,
          "create_time": "07/27/2025 01:00pm CDT"
        },
        {
          "id": 1,
          "file": "",
          "name": "Project Stats 07/26/2025 12:26pm CDT- 07/27/2025 12:26pm CDT",
          "size": 0,
          "count": 0,
          "ctime": 1753633593931,
          "create_time": "07/27/2025 12:26pm CDT"
        }
      ],
      "account": {
        "id": "api",
        "name": "api"
      },
      "ctime": 1753633592943,
      "mtime": 1753633593931,
      "create_time": "07/27/2025 12:26pm CDT",
      "update_time": "07/27/2025 12:26pm CDT"
    }
  ]
}

• Endpoint: /api/report/del/{rpid}

• Method: GET

• Request Parameters:

  • {rpid} - Unique identifier for the report.

• Response:
  Success: Returns empty result with status 200

  Error: Returns an appropriate error message when validation fails in the common format explained in General Overview

• Specific Errors
  If not marked as retry-able errors returned by this endpoint are final, no report has been deleted.

  Error codes:

  • 400
    Parameters provided are missing or invalid
  • 404
    Report id is invalid or does not exist
  • 403
    Access to the specified report denied, the report was created with more strict permissions