Custom Reports

List custom reports

Retrieves a list of custom reports with optional filtering. Reports are filtered by user's organization membership.

get/api/custom-reports

Request

Query parameters

userstring
Example:1,2,3

Filter by user ID

agencystring
Example:1,2,3

Filter by agency ID

brandstring
Example:1,2,3

Filter by brand ID

propertystring
Example:1,2,3

Filter by property ID

tagstring
Example:1,2,3

Filter by tag ID

organizationstring
Example:1,2,3

Filter by organization ID

publishedBeforestring date-time

Filter by reports published before the given date

publishedAfterstring date-time

Filter by reports published after the given date

Response

Custom reports list

Example response

{
  "data": [
    {
      "file": {
        "user_id": 1,
        "original_name": "document.pdf",
        "stored_name": "2023_01_document.pdf",
        "mime_type": "application/pdf",
        "file_size": 2048,
        "file_hash": "5fghjk234ghj234gj234g234",
        "url": "https://example.com/files/2023_01_document.pdf",
        "thumbnail_id": 2
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.