---
title: "Get a scheduled view."
method: GET
path: "/v1/scheduledViews/{id}"
tags: ["scheduledViewManagement"]
---

# Get a scheduled view.

`GET /v1/scheduledViews/{id}`

Get a scheduled view with the given identifier.

## Path parameters

- `id` string, required

## Response `200`

Scheduled view object that was requested.

- ScheduledView
  - `query` string, required — The query that defines the data to be included in the scheduled view.
  - `indexName` string, required — Name of the index for the scheduled view.
  - `startTime` string, date-time, required — Start timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
  - `retentionPeriod` integer — The number of days to retain data in the scheduled view, or -1 to use the default value for your account. Only relevant if your account has multi-retention enabled.
  - `dataForwardingId` string — An optional ID of a data forwarding configuration to be used by the scheduled view.
  - `parsingMode` string — Define the parsing mode to scan the JSON format log messages. Possible values are: 1. `AutoParse` 2. `Manual` In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011).
  - `timeZone` string — Time zone for ingesting data in scheduled view. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
  - `description` string — Description of the scheduled view.
  - `newRetentionPeriod` integer — If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time.
  - `retentionEffectiveAt` string, date-time — When the newRetentionPeriod will become effective in UTC format.
  - `id` string, required — Identifier for the scheduled view.
  - `indexId` string — The `id` of the Index where the output from Scheduled view is stored.
  - `createdAt` string, date-time — Creation timestamp in UTC.
  - `modifiedAt` string, date-time — Last modification timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
  - `createdByOptimizeIt` boolean — If the scheduled view is created by OptimizeIt.
  - `error` string — Errors related to the scheduled view.
  - `status` string — Status of the scheduled view. Possible values are: 1. `NOT_STARTED` 2. `FILLING` 3. `STOPPED` 4. `COMPLETE` 5. `FAILED` 6. `PAUSED`
  - `totalBytes` integer — Total storage consumed by the scheduled view.
  - `totalMessageCount` integer — Total number of messages for the scheduled view.
  - `createdBy` string — Identifier of the user who created the scheduled view.
  - `modifiedBy` string — Identifier of the user who last modified the resource.
  - `filledRanges` FilledRange[] — List of the different units of filled ranges since the autoview has been created.
    - `startTime` string, date-time, required — Start of the timestamp for each unit of filled ranges, expressed in UTC.
    - `endTime` string, date-time, required — End of the timestamp for each unit of filled ranges, expressed in UTC.
  - `lastAccessedAt` string, date-time — Last accessed timestamp in UTC

## Other responses

- `default` — Operation failed with an error.

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/18a824df1e78/schema)