PRprewave
Scores - Enterprise Export

Create or Update Export Configuration

Changed on

Create or replace the authenticated user's enterprise export configuration.

Each user has one configuration. A later call replaces it entirely. runInterval defaults to WEEKLY when omitted. enabled, collectionIds, targetIds, perspectiveIds, and includeComponents are required. collectionIds and targetIds may be empty arrays. An empty perspectiveIds list is accepted and saved, but the job then produces no scores.

Access to collections, targets, and perspectives is checked when the job runs, not when this request is saved. Use GET /public/v1/enterprise-export/scores and GET /public/v1/enterprise-export/scores/errors after a successful execution.

Required permission: access_enterprise_export_api

post/public/v1/enterprise-export/scores/config

Request

Request body

runInterval'SIX_HOURS' | 'TWELVE_HOURS' | 'DAILY' | 'WEEKLY' required
        Defines the time interval for running the export job.
        Options include SIX_HOURS, TWELVE_HOURS, DAILY, and WEEKLY.
        Defaults to WEEKLY if not specified.
enabledboolean required

Indicates whether the export job is enabled. If false, the job will not run.

collectionIdsinteger[] required

List of Prewave Collection IDs to include in the export job.

targetIdsinteger[] required

List of Target IDs to include in the export job.

perspectiveIdsinteger[] required

List of Perspective IDs to include in the export job.

includeComponentsboolean required
        Indicates whether to include score components and subcomponents in the export result.
        If true, components will be included.

Example request

{
  "runInterval": "WEEKLY",
  "enabled": true,
  "collectionIds": [
    123,
    456,
    789
  ],
  "targetIds": [
    101,
    202,
    303,
    102006215
  ],
  "perspectiveIds": [
    1,
    2,
    3
  ]
}

Response

Configuration saved. The response body is empty. Read it back with GET scores/config.

Changes