PRprewave
Scores - Enterprise Export

Get Export Configuration

Retrieve the authenticated user's enterprise export configuration.

runInterval is SIX_HOURS, TWELVE_HOURS, DAILY, or WEEKLY. The job runs only when enabled is true and the interval since the last execution has elapsed. collectionIds and targetIds are combined. perspectiveIds must contain at least one id to produce scores. includeComponents adds component and subcomponent breakdowns to score results.

When no configuration has been saved, the response is disabled, weekly, and has empty id lists. An empty perspectiveIds list does not generate scores.

Collection ids come from GET /public/v1/collections. Target ids come from GET /public/v2/suppliers/sites (prewaveTargetId).

Required permission: access_enterprise_export_api

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

Request

Response

The saved configuration, or the disabled default when none exists.

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 response

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

Changes

No recorded changes to this operation across all 28 revisions of this API.