Skip to main content
GET
Get a report

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

report_id
string
required

The report_id identifier.

Query Parameters

data
integer

Pass data=1 to execute the report query and return rows. Without this, only the report schema (controls, fields, visual) is returned.

params
integer

Pass params=1 to include the resolved query parameters in the response. Useful for debugging filter values.

format
string

Pass format=csv to stream the report data as a CSV download instead of JSON.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A generated report configuration — NOT a saved custom report record.