---
title: "Get Export Configuration"
method: GET
path: "/public/v1/enterprise-export/scores/config"
tags: ["Scores - Enterprise Export"]
---

# Get Export Configuration

`GET /public/v1/enterprise-export/scores/config`

## Request

- Base URL: `https://api.prewave.com`
- URL: `https://api.prewave.com/public/v1/enterprise-export/scores/config`
- Auth: API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/prewave/apis/public-prewave-api/docs/public/v1/enterprise-export/scores/config/get.ts> (a function with typed inputs; its response is checked against the schema)

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`

## Response `200`

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

- PublicScoreExecutionConfig
  - `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.
  - `enabled` boolean, required: Indicates whether the export job is enabled. If false, the job will not run.
  - `collectionIds` integer[], required: List of Prewave Collection IDs to include in the export job.
  - `targetIds` integer[], required: List of Target IDs to include in the export job.
  - `perspectiveIds` integer[], required: List of Perspective IDs to include in the export job.
  - `includeComponents` boolean, required: Indicates whether to include score components and subcomponents in the export result. If true, components will be included.

## Other responses

- `403`: 403 Forbidden - Authentication or authorization failure. This status code is returned when: (1) the request lacks valid authentication credentials (missing or invalid X-Auth-Token header), or (2) the authenticated user does not have the required permission to access this resource.
- `429`: 429 Too Many Requests - API rate limit exceeded. The request has been rejected because the rate limit for this endpoint has been exceeded. Default rate limits: GET requests - 100 per 10 seconds, 500 per minute; POST/PUT/PATCH/DELETE requests - 20 per 10 seconds, 100 per minute. For increased access, please contact customer success.
- `500`: 500 Internal Server Error - An unexpected error occurred on the server. The request may or may not have been processed.

---

[API](https://skmtc.dev/prewave/apis/public-prewave-api.md) - [All operations](https://skmtc.dev/prewave/apis/public-prewave-api/llms.txt) - [OpenAPI document](https://skmtc.dev/prewave/apis/public-prewave-api/revisions/d07712f25b17?raw)