Docs

Publish Analytics Page

Publish the draft: it becomes a new numbered version and what viewers see. Until then, people the page is shared with keep seeing the last published version.

POST

Path

Path parameters
stringrequired

The page id, from List Analytics Pages.

Headers

Optional headers
stringrequired

Required. The revision you last read: the revision from its read (Get Workflow Definition for a workflow, Get Analytics Page Definition for an Analytics page, Get Analytics Data Source Table for a fixed source's table), or meta.revision from your last change to it. The ETag header of either answer is the same value, ready to send back. The change applies only if nobody changed it since: otherwise it answers 412 with the current revision in error.details.revision. Send it as a strong entity tag ("r_..."): a weak one (W/"...") never matches and answers 412. Without it the request answers 428.

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments
string

The receipt a 409 ANALYTICS_EMBED_CONFIRMATION_REQUIRED answered, to confirm the change to published embeds.

Only after a 409 ANALYTICS_EMBED_CONFIRMATION_REQUIRED for the same request: the confirmationReceipt from its error.details, confirming the change to the published embeds it lists.

Response fields

idstring

The version id.

versionnumber

The version number, counting up from 1.

namestring

Its name, or null.

notesstring

Its notes, or null.

isPublishedboolean

Whether it is the version viewers see.

createdBystring

The userId of who published it, from List Members, or null.

createdByNamestring

Who published it, or null.

createdOndate

When it was made.

publishedOndate

When it was last made the version viewers see, or null.