Objects

cid - Your organization ID

report - The original report title submitted, immutable.

rpid - The report ID

title - The title or name of the report, usually indicating info about the report.

email - The email address that will get report notifications.

update_time - The modification time of the report in human date-time format.

created_time - The creation time of the report in human date-time format.

interval - If provided during the creation, will indicate how frequently the reports runs in minutes.

requested_by - Information of the user that created the report: { name: the name of the user, id: unique user id}

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).

running, scheduled, done, error

files - An array of objects, each representing a file associated with the report.

id - ID of the file
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.
ctime - The time the file was created in milliseconds.

{
    "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": "[email protected]",
    "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"
        }
    ]
}