Skip to main content
GET
Get a shared report

Path Parameters

pid
string
required

The pid identifier.

Query Parameters

token
string

JWT token encoding the locked parameter values. Required when the shared report is configured with secure=true.

data
integer

Pass data=1 to include report rows in the response.

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.

cyx_provider
string

Override the reports provider used to resolve the shared report.

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.