Reports

List the caller's notification preferences

GET

/api/v1/organizations/{organization_id}/notification-preferences

GET

/api/v1/organizations/{organization_id}/notification-preferences

Path Parameters

organization_id*string

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

preferences*array<>|null

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/notification-preferences'

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/notification-preferences'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/PreferencesOutputBody.json",
  "preferences": [
    {
      "category": "string",
      "channel": "string",
      "enabled": true
    }
  ]
}

{  "$schema": "https://example.com/schemas/PreferencesOutputBody.json",  "preferences": [    {      "category": "string",      "channel": "string",      "enabled": true    }  ]}

PATCH

/api/v1/organizations/{organization_id}/notification-preferences

PATCH

/api/v1/organizations/{organization_id}/notification-preferences

Path Parameters

organization_id*string

Request Body

application/json

body

category*string

channel*string

enabled*boolean

Response Body

No Content

Example Request

curl -X PATCH 'https://example.com/api/v1/organizations/string/notification-preferences' \
  -H 'Content-Type: application/json' \
  -d '{
  "category": "string",
  "channel": "string",
  "enabled": true
}'

Example Request

curl -X PATCH 'https://example.com/api/v1/organizations/string/notification-preferences' \  -H 'Content-Type: application/json' \  -d '{  "category": "string",  "channel": "string",  "enabled": true}'

Example Response

Empty

Get one report run

GET

/api/v1/organizations/{organization_id}/report-runs/{run_id}

GET

/api/v1/organizations/{organization_id}/report-runs/{run_id}

Path Parameters

organization_id*string

run_id*string

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

run*

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/report-runs/string'

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/report-runs/string'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/GetRunOutputBody.json",
  "run": {
    "completedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "reportKey": "string",
    "rowCount": 0,
    "status": "string",
    "summary": null
  }
}

{  "$schema": "https://example.com/schemas/GetRunOutputBody.json",  "run": {    "completedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "id": "string",    "reportKey": "string",    "rowCount": 0,    "status": "string",    "summary": null  }}

List scheduled reports

GET

/api/v1/organizations/{organization_id}/report-schedules

GET

/api/v1/organizations/{organization_id}/report-schedules

Path Parameters

organization_id*string

Query Parameters

limit?integer

Page size (1-100)

Formatint64

Range1 <= value <= 100

Default20

cursor?string

Opaque cursor from meta.nextCursor

includeTotal?boolean

Set false to omit meta.total

Defaulttrue

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

data*array<>|null

meta*

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/report-schedules'

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/report-schedules'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/PageScheduleView.json",
  "data": [
    {
      "cadence": "string",
      "enabled": true,
      "format": "string",
      "id": "string",
      "lastRunAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "nextRunAt": "2019-08-24T14:15:22Z",
      "recipients": [
        {
          "accountId": "string",
          "email": "string",
          "kind": "string"
        }
      ],
      "reportKey": "string",
      "sendHour": 0
    }
  ],
  "meta": {
    "hasMore": true,
    "limit": 0,
    "nextCursor": "string",
    "total": 0
  }
}

{  "$schema": "https://example.com/schemas/PageScheduleView.json",  "data": [    {      "cadence": "string",      "enabled": true,      "format": "string",      "id": "string",      "lastRunAt": "2019-08-24T14:15:22Z",      "name": "string",      "nextRunAt": "2019-08-24T14:15:22Z",      "recipients": [        {          "accountId": "string",          "email": "string",          "kind": "string"        }      ],      "reportKey": "string",      "sendHour": 0    }  ],  "meta": {    "hasMore": true,    "limit": 0,    "nextCursor": "string",    "total": 0  }}

Create a scheduled report

POST

/api/v1/organizations/{organization_id}/report-schedules

POST

/api/v1/organizations/{organization_id}/report-schedules

Path Parameters

organization_id*string

Request Body

application/json

body

cadence*string

daily, weekly, or monthly.

name*string

recipients*array<>|null

reportKey*string

sendHour*integer

UTC hour 0-23.

Formatint32

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

schedule*

Example Request

curl -X POST 'https://example.com/api/v1/organizations/string/report-schedules' \
  -H 'Content-Type: application/json' \
  -d '{
  "cadence": "string",
  "name": "string",
  "recipients": [
    {
      "kind": "string"
    }
  ],
  "reportKey": "string",
  "sendHour": 0
}'

Example Request

curl -X POST 'https://example.com/api/v1/organizations/string/report-schedules' \  -H 'Content-Type: application/json' \  -d '{  "cadence": "string",  "name": "string",  "recipients": [    {      "kind": "string"    }  ],  "reportKey": "string",  "sendHour": 0}'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/ScheduleOutputBody.json",
  "schedule": {
    "cadence": "string",
    "enabled": true,
    "format": "string",
    "id": "string",
    "lastRunAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nextRunAt": "2019-08-24T14:15:22Z",
    "recipients": [
      {
        "accountId": "string",
        "email": "string",
        "kind": "string"
      }
    ],
    "reportKey": "string",
    "sendHour": 0
  }
}

{  "$schema": "https://example.com/schemas/ScheduleOutputBody.json",  "schedule": {    "cadence": "string",    "enabled": true,    "format": "string",    "id": "string",    "lastRunAt": "2019-08-24T14:15:22Z",    "name": "string",    "nextRunAt": "2019-08-24T14:15:22Z",    "recipients": [      {        "accountId": "string",        "email": "string",        "kind": "string"      }    ],    "reportKey": "string",    "sendHour": 0  }}

Update a scheduled report

PATCH

/api/v1/organizations/{organization_id}/report-schedules/{schedule_id}

PATCH

/api/v1/organizations/{organization_id}/report-schedules/{schedule_id}

Path Parameters

organization_id*string

schedule_id*string

Request Body

application/json

body

cadence*string

daily, weekly, or monthly.

enabled*boolean

name*string

recipients*array<>|null

sendHour*integer

UTC hour 0-23.

Formatint32

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

schedule*

Example Request

curl -X PATCH 'https://example.com/api/v1/organizations/string/report-schedules/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "cadence": "string",
  "enabled": true,
  "name": "string",
  "recipients": [
    {
      "kind": "string"
    }
  ],
  "sendHour": 0
}'

Example Request

curl -X PATCH 'https://example.com/api/v1/organizations/string/report-schedules/string' \  -H 'Content-Type: application/json' \  -d '{  "cadence": "string",  "enabled": true,  "name": "string",  "recipients": [    {      "kind": "string"    }  ],  "sendHour": 0}'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/ScheduleOutputBody.json",
  "schedule": {
    "cadence": "string",
    "enabled": true,
    "format": "string",
    "id": "string",
    "lastRunAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nextRunAt": "2019-08-24T14:15:22Z",
    "recipients": [
      {
        "accountId": "string",
        "email": "string",
        "kind": "string"
      }
    ],
    "reportKey": "string",
    "sendHour": 0
  }
}

{  "$schema": "https://example.com/schemas/ScheduleOutputBody.json",  "schedule": {    "cadence": "string",    "enabled": true,    "format": "string",    "id": "string",    "lastRunAt": "2019-08-24T14:15:22Z",    "name": "string",    "nextRunAt": "2019-08-24T14:15:22Z",    "recipients": [      {        "accountId": "string",        "email": "string",        "kind": "string"      }    ],    "reportKey": "string",    "sendHour": 0  }}

Delete a scheduled report

DELETE

/api/v1/organizations/{organization_id}/report-schedules/{schedule_id}

DELETE

/api/v1/organizations/{organization_id}/report-schedules/{schedule_id}

Path Parameters

organization_id*string

schedule_id*string

Response Body

No Content

Example Request

curl -X DELETE 'https://example.com/api/v1/organizations/string/report-schedules/string'

Example Request

curl -X DELETE 'https://example.com/api/v1/organizations/string/report-schedules/string'

Example Response

Empty

List the report catalogue available to the caller

GET

/api/v1/organizations/{organization_id}/reports

GET

/api/v1/organizations/{organization_id}/reports

Path Parameters

organization_id*string

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

reports*array<>|null

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/reports'

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/reports'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/ListOutputBody.json",
  "reports": [
    {
      "capability": "string",
      "description": "string",
      "entries": true,
      "key": "string",
      "title": "string"
    }
  ]
}

{  "$schema": "https://example.com/schemas/ListOutputBody.json",  "reports": [    {      "capability": "string",      "description": "string",      "entries": true,      "key": "string",      "title": "string"    }  ]}

Generate a report (entries and summary); set format=csv for an export

GET

/api/v1/organizations/{organization_id}/reports/{report_key}

GET

/api/v1/organizations/{organization_id}/reports/{report_key}

Path Parameters

organization_id*string

report_key*string

Query Parameters

eventId?string

from?string

Inclusive lower bound, RFC 3339.

to?string

Exclusive upper bound, RFC 3339.

format?string

json or csv

Default"json"

Response Body

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/reports/string'

Example Request

curl -X GET 'https://example.com/api/v1/organizations/string/reports/string'

Example Response

Empty

Generate and record a report run

POST

/api/v1/organizations/{organization_id}/reports/{report_key}/runs

POST

/api/v1/organizations/{organization_id}/reports/{report_key}/runs

Path Parameters

organization_id*string

report_key*string

Query Parameters

eventId?string

from?string

Inclusive lower bound, RFC 3339.

to?string

Exclusive upper bound, RFC 3339.

format?string

json or csv

Default"json"

Response Body

application/json

response

$schema?string

A URL to the JSON Schema for this object.

Formaturi

run*

Example Request

curl -X POST 'https://example.com/api/v1/organizations/string/reports/string/runs'

Example Request

curl -X POST 'https://example.com/api/v1/organizations/string/reports/string/runs'

Example ResponseSchema

{
  "$schema": "https://example.com/schemas/CreateRunOutputBody.json",
  "run": {
    "completedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "reportKey": "string",
    "rowCount": 0,
    "status": "string",
    "summary": null
  }
}

{  "$schema": "https://example.com/schemas/CreateRunOutputBody.json",  "run": {    "completedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "id": "string",    "reportKey": "string",    "rowCount": 0,    "status": "string",    "summary": null  }}

List the caller's notification preferencesCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Set one notification preference or consentCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Get one report runCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List scheduled reportsCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Create a scheduled reportCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Update a scheduled reportCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a scheduled reportCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List the report catalogue available to the callerCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Generate a report (entries and summary); set format=csv for an exportCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Generate and record a report runCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List the caller's notification preferences

Path Parameters

Response Body

Set one notification preference or consent

Path Parameters

Request Body

Response Body

Get one report run

Path Parameters

Response Body

List scheduled reports

Path Parameters

Query Parameters

Response Body

Create a scheduled report

Path Parameters

Request Body

Response Body

Update a scheduled report

Path Parameters

Request Body

Response Body

Delete a scheduled report

Path Parameters

Response Body

List the report catalogue available to the caller

Path Parameters

Response Body

Generate a report (entries and summary); set format=csv for an export

Path Parameters

Query Parameters

Response Body

Generate and record a report run

Path Parameters

Query Parameters

Response Body