Skip to main content
POST
Save

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The ReportingServiceSaveRequest message.

conversationId
string

The conversation and surface are both required to address a rendered surface; neither identifies one alone.

displayName
string

Required for a new report and rejected when report_id is set.

expectedProgramId
string

Required with report_id. A stale source version is rejected rather than silently overwriting a newer edit.

prompt
string

The question this surface answered. Used only when creating a report; applying an edit preserves the report's canonical question and records the incremental instruction on the immutable run.

reportId
string

Empty creates a report. Set to apply the validated edit surface to an existing report without changing its identity or history.

surfaceId
string

The surfaceId field.

Response

200 - application/json

Successful response

The ReportingServiceSaveResponse message.

report
Report · object | null

Report is a saved report: the question, the program that answers it, and the parameters a re-run may vary.