reports

Save saved reports

Create or replace a saved report: a name and a report definition, which names the dataset and the campaign and date range it reads. Omit id to create one, which the server names; a retry with the same Idempotency-Key returns the report its first attempt made. Pass the id of one of the organization's reports and the updatedAt you read it at (expectedUpdatedAt) to replace it: a report changed since is 409 STALE_WRITE (read it again), a deleted one is 409 PRECONDITION_FAILED, and an id that is not the organization's report is 404 RESOURCE_NOT_FOUND. A definition that does not fit its dataset is 400 INVALID_INPUT with details.issues; a campaign that is not the organization's campaign of the dataset's product is 404 RESOURCE_NOT_FOUND.

post/api/v1/reports/saved-reports/save

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/reports/saved-reports/save
  • 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)

Headers

Point11-Organizationstring uuid

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

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

idstring uuid

One of the organization's reports to replace, with expectedUpdatedAt; omit it to create a report (the server names it).

expectedUpdatedAtstring date-time

The updatedAt the report was read at; a replace is refused once it moved.

namestring required

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.