OverviewViews Beta

Get view

Retrieve a specific view by its key.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

projectKeystringRequired
viewKeystringRequired

Headers

LD-API-VersionenumRequired
Version of the endpoint.
Allowed values:

Query parameters

sortenumOptional
A sort to apply to the list of views.
Allowed values:
limitintegerOptional
The number of views to return.
offsetintegerOptional

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

filterstringOptional

A filter to apply to the list of views. Supports the following fields and operators: name (equals, notEquals, startsWith, contains, anyOf), key (equals, notEquals, startsWith, contains, anyOf), tag (equals, anyOf), maintainerId (equals, anyOf), isPayloadView (equals).

expandlist of enumsOptional

A comma-separated list of fields to expand.

Response

Successful response
idstringformat: "string"
Unique ID of this view
accountIdstring
ID of the account that owns this view
projectIdstring
ID of the project this view belongs to
projectKeystring
Key of the project this view belongs to
keystring

Unique key for the view within the account/project

namestring

Human-readable name for the view

descriptionstring
Optional detailed description of the view
generateSdkKeysboolean
Whether to generate SDK keys for this view. Defaults to false.
versioninteger
Version number for tracking changes
tagslist of strings
Tags associated with this view
createdAtlong
updatedAtlong
archivedbooleanDefaults to false
Whether this view is archived
deletedbooleanDefaults to false
Whether this view is deleted
_accessobject or null
archivedAtlong or null
deletedAtlong or null
maintainerobject or null
flagsSummaryobject or null
segmentsSummaryobject or null
metricsSummaryobject or null
aiConfigsSummaryobject or null
resourceSummaryobject or null
flagsExpandedobject or null

Details on linked flags for a view - requires passing the ‘allFlags’ expand field

segmentsExpandedobject or null

Details on linked segments for a view - requires passing the ‘allSegments’ expand field

metricsExpandedobject or null
aiConfigsExpandedobject or null
resourcesExpandedobject or null

Details on linked resources for a view - requires passing the ‘allResources’ expand field

Errors