MYmyaltimate
ALERTS_V1

Start Playground Report Preview Run

Changed on

Start a report preview in the background and return at once.

The alerts worker generates the report the way the scheduled run would, keeps it on the session and emails it to the caller only. Poll GET /preview/playground-report/runs/{session_id} for its state; send the kept report on with POST .../runs/{run_id}/send. 409 while another run holds the session.

post/api/v1/alerts/preview/playground-report/runs

Request

  • Base URL
    https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.myaltimate.com/api/v1/alerts/preview/playground-report/runs
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

session_idstring required
content_scopestring

first_query | last_answer | full_chat

report_namestring nullable

The rule's name (or the name typed into an unsaved form). Reaches the subject line, so pass it for the preview to match what a scheduled run would send. Falls back to a placeholder.

Response

Successful Response

idstring required
kindstring required
statestring required
started_atstring required
finished_atstring nullable
errorstring nullable
report_namestring nullable
content_scopestring nullable
emailed_tostring nullable
email_errorstring nullable

Changes