SIsilverflow
Retrieve Reports

List Reports

Returns a list of reports.

Requires the reports:List permission.

get/reports

Request

Query parameters

createdFromstring date-time

Include only items that have a created date greater than or equal to the specified date

createdTostring date-time

Include only items that have a created date less than or equal to the specified date

limitinteger

The maximum number of reports to retrieve in a single request.

offsetTokenstring
Example:LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc

Token representing the offset for paginated results. Use the token from the last response to retrieve the next set of items.

sortOrder'asc' | 'desc'

The sort order in which reports should be sorted. Based on the entity creation time.

asc for ascending order, desc for descending order.

Response

List of reports

moreItemsboolean required

Boolean indicating if there are more items to retrieve

offsetTokenstring

Example response

{
  "items": [
    {
      "key": "rep-1e1dAHhgstYTUhlphPzZ",
      "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
      "distributions": [
        "dst-1e1dAHhgstYTUhlphPzZ"
      ],
      "reportScheduleKey": "rsk-1e1dAHhgstYTUhlphPzZ"
    }
  ],
  "offsetToken": "LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc"
}

Changes

No recorded changes to this operation across all 1 revision of this API.