Skip to main content
GET
Get a reporter

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

reporter_id
string
required

Reporter to retrieve.

Pattern: ^rptr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

Reporter details with the latest hosted purpose and output sample.

id
string
required

Reporter ID.

name
string
required

Owner-scoped reporter name.

display_name
string
required

Human-readable reporter name.

description
string
required

Explanation of what the reporter does.

user_id
string
required

User who owns the reporter.

created_at
string<date-time>
required

Time the reporter was created.

author
UserRow · object | null

Public profile of the reporter owner.

latest_version
integer | null

Latest visible hosted version number. Null identifies an external reporter.

outputs
OutputDecl · object[]

Output parts declared by the reporter.

run_count
integer
default:0

Number of visible hosted runs.

output_count
integer
default:0

Number of visible output parts.

purpose
string | null

Purpose declared by the latest hosted version, if any.

latest_output
ReporterOutputPublic · object | null

Most recent output part visible to the caller, if any.