---
title: "List Reports"
method: GET
path: "/network-reporting/v1/reports"
tags: ["Reporting"]
---

# List Reports

`GET /network-reporting/v1/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.

## Query parameters

- `search` string
- `filter` string
- `sort` string
- `next` string
- `limit` integer

## Response `200`

List Report Response

- ListReports — List of reports response.
  - `items` Report[], required — List of report objects.
    - `id` string, required
    - `type` string, required — Type of the resource.
    - `name` string — Name of the webhook. Must be unique per customer.
    - `reportScope` ReportScope — Specifies the scope type and target values for the report
      - `scopeType` string
      - `values` unknown[]
        - unknown
    - `reportType` string — Specifies the particular report type (lowerCamelCase or lowercase). Valid values: appAnalytics, capacityPlanning, clientInventory, clientSession, custom, deviceUptime, licenses, mspcustomer, mspinventory, msplicense, mspsubscription, networkUsage, resourceUtilization, rfHealth, securityCompliance, visitor, wids. Refer to the Create Report operation documentation for complete details on supported types and their associated filters.
    - `createdBy` string — The user who saved the report.
    - `createdAt` string, date-time, required — Provides the timestamp ISO 8601 format when the computed client location is persisted in database.
    - `generation` integer, required — Generation number of the webhook.
    - `updatedBy` string — The user who modified the report / report schedule.
    - `updatedAt` string, date-time, required — Time when the resource was last updated.
    - `lastModifiedBy` string — The user who modified the report / report schedule.
    - `lastModifiedAt` string, date-time — Specifies the report modified timestamp in UTC+0 timezone (RFC 3339 format).
    - `reportSchedule` ReportSchedule — Specifies the report Schedule
      - `scheduleType` 'ONE_TIME' | 'EVERY_DAY' | 'EVERY_WEEK' | 'EVERY_MONTH' — Specifies the Schedule types Once, Every Day, Every Week, Every Month etc.
      - `lastRunTs` string, date-time — Specifies the timestamp of the last report run in UTC+0 timezone (RFC 3339 format).
      - `lastRunStatus` 'NEW' | 'ACTIVE' | 'PAUSED' | 'STOPPED' | 'COMPLETED' | 'ERROR' — Specifies the run status as New, Active, Paused, Stopped, Completed, or Error
      - `nextRunTs` string, date-time — Specifies the report period next run timestamp in UTC+0 timezone (RFC 3339 format).
      - `completedRuns` integer — Total number of completed runs for the report schedule.
      - `totalRuns` integer — Total number of runs that the report schedule has executed.
      - `scheduleEnd` string, date-time — Specifies the scheduled end timestamp in UTC+0 timezone (RFC 3339 format).
  - `count` integer, required — The number of reports after filtering.
  - `total` integer — The total number of reports.
  - `next` string, required — Specifies the pagination cursor for the next page of resources. null if there are no further pages.

## Other responses

- `400` — Invalid input received.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `404` — Not Found error.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/arubanetworks/authorization/revisions/74c95058b11f/schema)