reports

Get saved reports

Read one saved report by id: its name, product, dataset, campaign, status and report definition, and updatedAt, which a replace names to show what it edited. A deleted report, or one that is not the organization's, is 404 RESOURCE_NOT_FOUND.

get/api/v1/reports/saved-reports/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/reports/saved-reports/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

idstring uuid required
namestring required
product'discovery' | 'experience' | 'research' required

The product whose results a report reads.

datasetstring required

The dataset the report reads (reports.datasets.list.v1).

campaignIdstring uuid nullable required

The campaign the report reads; null when it reads every campaign of its product.

status'active' | 'archived' required
createdByUserIdstring uuid nullable required

Who created the report; attribution only.

createdByNamestring nullable required

The creator's name as the member list shows it; null once the account is gone.

createdAtstring date-time required

ISO instant, at the store's microsecond precision.

updatedAtstring date-time required

When the report last changed; a replace names it as expectedUpdatedAt.

Changes

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