Report Scheduling

List Report Schedules

Lists all active report schedules.

It requires the reportSchedules:List permission in the API key.

get/reportSchedules

Request

Query parameters

reportName'SchemeFeeDetails'

The name of the report.

The report name to filter on

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

The report schedules

moreItemsboolean required

Boolean indicating if there are more items to retrieve

offsetTokenstring

Example response

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

Changes

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