Skip to main content
GET
List reporters

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Query Parameters

q
string | null

Substring match on name, title, description, or version purpose.

type
string[] | null

Keep reporters producing at least one part of this type.

mode
string
default:all

Reporter hosting mode to return.

Pattern: ^(all|hosted|external)$
author
string | null

Owner user id (exact).

limit
integer
default:200

Maximum reporters returned.

Required range: 1 <= x <= 500
cursor
string | null

Continuation cursor returned in the previous response header.

Response

Successful Response

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.