Create a reporter run | Softmax docs

POST/v2/reporters/runs

Queues an on-demand reporter run against episodes, a round, league, player, or freeform input. The response is accepted before execution completes.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Request Body

application/json

Reporter binding, subject, and run options.

reporter*|

Reporter version to run.

params?|

Parameters passed to the reporter.

limits?|

Run-limit overrides.

dependencies?array<>

Reporter runs that must complete before this run.

subject*

Resource the reporter will analyze, such as episodes, a round, league, player, or freeform input.

publish_post?Publish Post

Whether to publish the completed render output as a post.

Defaultfalse

debug?Debug

Whether to retain additional debugging information for the run.

Defaultfalse

idempotency_key?|

Caller-chosen key for reusing the same on-demand run request.

bash

curl -X POST "https://example.com/v2/reporters/runs" \
  -H "Content-Type: application/json" \
  -d '{
    "reporter": {
      "reporter_version_id": "string"
    },
    "subject": {}
  }'

json

{
  "id": "string",
  "status": "pending",
  "reporter_version_id": "string",
  "subject": {},
  "status_url": "string",
  "output_url": "string",
  "trace_url": "string",
  "usage": {},
  "output_parts": [
    {
      "id": "string",
      "reporter_id": "string",
      "reporter_run_id": "string",
      "name": "string",
      "type": "string",
      "size_bytes": 0,
      "content_hash": "string",
      "media_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "url": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "running_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "error": "string"
}