Schedule an Insights export

POST/api/v1/exports/schedules

Requires an Organization API key with the edit capability.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Request Body

application/json

name*string

Length1 <= length <= 120

kind*string

Value in

"insights_overview"
"insights_datapoints"
"insights_languages"

format*string

Value in

"csv"
"json"
"xlsx"

filters?

Default{}

cadence*|

hour*integer

Range0 <= value <= 23

recipientMemberIds*array<>

Items1 <= items <= 100

enabled?boolean

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/exports/schedules" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "kind": "insights_overview",    "format": "csv",    "cadence": {      "kind": "weekly",      "weekday": 0    },    "hour": 0,    "recipientMemberIds": [      "string"    ]  }'

{  "id": "string",  "organizationId": "string",  "name": "string",  "kind": "insights_overview",  "format": "json",  "filters": {    "property1": "string",    "property2": "string"  },  "cadence": {    "kind": "weekly",    "weekday": 0  },  "hour": 0,  "enabled": true,  "recipientMemberIds": [    "string"  ],  "createdBy": null,  "lastSlotAt": null,  "createdAt": "string",  "updatedAt": "string"}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Schedule an Insights export

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`