Skip to main content
Loading...

API docs by

Delete your generated reports

Request

Use this API to delete specific generated reports of an authenticated user by the generated reports' report IDs.

Query
reportIdsArray of strings, [ 1 .. 20 ] items, uniquerequired

Comma separated report ids to be deleted.

Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
Array [
reportIdstring, (uuid)required

A unique UUID string denoting the id of the report entry

Example:"8f204c59-f70f-437b-92d5-dbbde2932de5"
scheduledIdstring, (uuid)

Scheduled Id for the report entry

Example:"886fc5de-6304-46c7-902c-d946c656c169"
reportNamestring, non-empty

Name of the report

Example:"Duis"
fileNamestring, non-empty

File name of the report

Example:"velit Duis sit"
fileTypestring, non-empty

File type of the report

Enum:"XLS""CSV""PDF"
Example:"XLS"
fileSizenumber, >= 0

Size of the report in bytes

Example:95806395
createdForstring

Person/Entity whom this entry belongs to

requestedDatestring, (date-time)

Time when this entry was first requested

Example:"2807-08-28T13:34:33.735Z"
generatedDatestring, (date-time)

Time when this entry was generated

Example:"2847-09-19T23:25:35.305Z"
statusstring(ReportStatus)required

Status of the report

Enum:"IN_PROGRESS""DELAYED""SUCCESS""ERROR""INACTIVE"
Example:"SUCCESS"
numberOfDownloadsinteger, >= 0

Number of times this report is downloaded by the customer

Default:0
Example:1
]
Response
[
  {
    "reportId": "e96b42b6-ef0f-458f-a3f2-a5fd188236d7",
    "status": "SUCCESS"
  },
  {
    "reportId": "75e7c1e3-8593-4afa-ab75-b80b341d5547",
    "status": "ERROR"
  },
  {
    "reportId": "737b187c-3c28-4bd2-8c4c-b46c95e69547",
    "status": "SUCCESS"
  }
]
Was this page helpful?