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.

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

Endpoint:

https://app.rumbleup.com/api/report

• cid - Your organization ID
• cname - Your organization Name
• rpid - The report ID
• title - The title or name of the report, usually indicating info about the report.
• type - The type of report
• email - The email address that will get report notifications.
• mtime - The modification time of the report in milliseconds.
• stime - The start time of the report or campaign in milliseconds.
• ctime - The creation time of the report in milliseconds.
• account - An object containing details about the account associated with the report.
  • type - An array of strings indicating the types of operations or data associated with the account (e.g., “actions”, “admins”, “billing”).
  • name - The name of the account.
  • id - The unique identifier for the account.
• query - An object for storing any query parameters or filters used to generate the report.
• status - The current status of the report (e.g., “done” indicating that the report is completed).
• files - An array of objects, each representing a file associated with the report.
  • file - The unique identifier for the file.
  • name - The name of the file.
  • 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 (e.g., “csv” for a comma-separated values file).
  • url - The URL to download the file.

Example Object

{
    "cid": "c_example12345",
    "cname": "Example Account",
    "rpid": "example-report-id-123456",
    "title": "Project Stats 2024-08-20 13:11:51 GMT-0500 - 2024-08-21 13:11:51 GMT-0500",
    "type": "p2pt",
    "email": "example@example.com",
    "mtime": 1724263911872,
    "stime": 1724263911801,
    "ctime": 1724263908900,
    "account": {
        "type": [
            "actions",
            "admins",
            "billing",
            "campaign",
            "contacts",
            "csv",
            "users"
        ],
        "name": "example_account",
        "id": "u_exampleid12345",
    },
    "query": {},
    "status": "done",
    "files": [
        {
            "file": "examplefileid12345",
            "name": "Project Stats 2024-08-20 13:11:51 GMT-0500 - 2024-08-21 13:11:51 GMT-0500",
            "size": 1135,
            "count": 2,
            "ext": "csv",
            "url": "/api/report/download/examplefileid12345.csv"
        }
    ]
}

• Endpoint: /api/report/create
• Method: POST
• Description: Create a new report.
• Request Body Parameters:
  • type - The type of report.
  • title - The title or name of the report.
  • .... - any additional parameters per specific report type
• Returns
  An report object

Example Request:

curl -XPOST -u CID:KEY -d 'type=p2pt&title=ProjectStats' https://app.rumbleup.com/api/report/create

Example Response:

{
    "rpid": "RPID",
    ...
}

• Endpoint: /api/report/get/{rpid}
• Method: GET or POST
• Description: Check the status of a report by its ID.
• Request Body Parameters:
  {rpid} - Unique identifier for the report.
• Returns
  A Report object

Example Request:

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

Example Response:

{
    "status": "done",
    "files": [
        {
            "file": "examplefileid12345",
            "ext": "csv",
            "url": "/api/report/download/examplefileid12345.csv"
        }
    ]
    ...
}

• Endpoint: /api/report/download/{file}
• Method: GET
• Description: Download a file from a completed report using the file’s ID (not the report ID).
• Request Body Parameters:
  {file}: The name of the file to download, including the extension. This is found in the report’s files list under file and ext, or you can use https://app.rumbleup.com/ + url.
• Returns
  A CSV report file with data

Example Request:

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

• Endpoint: /api/report/list
• Method: GET or POST
• Description: Retrieve a list of all available reports.
• Request Body Parameters:
  ** None
• Returns:
  A list of report objects

Example Request:

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

Example Response:

{
    "count": 3,
    "data": [...]
}

• Endpoint: /api/report/del/{rpid}
• Method: GET or POST
• Request Parameters:
  • {rpid} - Unique identifier for the report.
• Returns:
  HTTP status 200 on success or an error

Example Request:

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