v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Reporting

List Reports

This API endpoint returns User Reports filtered by the specified query parameters. Each report contains key details such as ID, name, type, and scope. Use the query parameters to filter results and retrieve only data that matches your specific requirements.

get/network-reporting/v1/reports

Query parameters

searchstring

Search the Report based on Name, Type, Status and Saved By

filterstring

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the table below.

Field	Operators
status (last run status)	eq and in
scheduleType (report schedule type)	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring

Sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

If a direction indicator is omitted the default direction is ascending.

Supported fields are

Sort Field	Description
name	The name of the report.
scope	The specific sites where the report applies.
type	The type or category of the report (e.g., inventory, client).
createdBy	User who created the report.
scheduleType	Type of schedule for the report (e.g., recurring, one-time).
scheduleLastRunTs	Timestamp of the last time the report was executed.
scheduleNextRunTs	Timestamp of the next scheduled run for the report.
scheduleTotalRuns	Total number of times the report has been run.
scheduleEnd	The end date or timestamp of the report schedule.

nextstring

Specifies the pagination cursor for the next page of resources. Minimum value is 1.

limitinteger

Maximum number of reports to be retrieved. Allowed range is 1 to 100.

Response

List Report Response

countinteger required

The number of reports after filtering.

totalinteger

The total number of reports.

nextstring required

Specifies the pagination cursor for the next page of resources. null if there are no further pages.

Example response

{
  "items": [
    {
      "createdAt": "2023-02-14T12:23:00.000Z",
      "updatedAt": "2023-10-01T12:00:00Z"
    }
  ]
}