SPsponsorunited
Custom Reports

Create a custom report

Creates a new custom report with associated entities and file uploads.

post/api/custom-reports

Request

Request body

titlestring required

Report title

descriptionstring nullable

Report description

report_file_idinteger nullable

Report file ID (infographic PDF)

thumbnail_urlstring nullable

Thumbnail image URL

published_atstring date-time nullable

Publication date

brandsstring

Associated brand IDs (comma-separated)

propertiesstring

Associated property IDs (comma-separated)

agenciesstring

Associated agency IDs (comma-separated)

organizationsstring

Organization IDs (assigns to ALL users in org, comma-separated)

usersstring

Individual user IDs (comma-separated)

Example request

{
  "brands": "1,2,3",
  "properties": "1,2,3",
  "agencies": "1,2,3",
  "organizations": "1,2,3",
  "users": "1,2,3"
}

Response

Custom report created successfully

idinteger
titlestring
descriptionstring nullable
report_file_idinteger nullable
thumbnail_urlstring nullable
published_atstring date-time nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
sent_countinteger

Number of users this report was shared with

opened_countinteger

Number of recipients who have viewed the report

Example response

{
  "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.