openapi: 3.0.1 info: description: 'Consumer-to-Extole integration endpoints: consumer event submission, zone rendering, profile management, and SDK-backing operations for browser and native app environments.' title: Integration API - Consumer to Extole Audiences Reports API version: '1.0' servers: - description: Production url: https://{brand}.extole.io variables: brand: default: yourcompany description: Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io) security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Reports paths: /v4/reports: get: description: Returns all report runs visible to the authenticated client, optionally filtered by the provided query parameters. operationId: listReports parameters: - in: query name: report_type_name schema: type: string - in: query name: display_name schema: type: string - in: query name: status schema: items: enum: - CANCELED - DONE - EXPIRED - FAILED - IN_PROGRESS - PENDING - PENDING_DATA - SFTP_DELIVERY_FAILED type: string type: array uniqueItems: true - in: query name: user_ids schema: items: type: string type: array uniqueItems: true - in: query name: having_any_tags schema: type: string - in: query name: having_all_tags schema: type: string - in: query name: exclude_having_any_tags schema: type: string - in: query name: exclude_having_all_tags schema: type: string - in: query name: search_query schema: type: string - in: query name: creation_interval schema: type: string - in: query name: offset schema: type: string - in: query name: limit schema: type: string - in: query name: order_by schema: enum: - DATE_COMPLETED - DATE_RUN - NAME - STATUS - USER type: string - in: query name: order schema: enum: - ASCENDING - DESCENDING type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ReportResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_limit: $ref: '#/components/examples/invalid_limit' invalid_offset: $ref: '#/components/examples/invalid_offset' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_timerange_format: $ref: '#/components/examples/invalid_timerange_format' max_fetch_size_1000: $ref: '#/components/examples/max_fetch_size_1000' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: List reports tags: - Reports x-extole-bundle: management x-extole-visibility: visible post: description: Submits a new report run for the specified report type and parameters. The report executes asynchronously; poll the returned report ID to check status. operationId: createReport requestBody: content: application/json: example: display_name: display_name format: CSV formats: - CSV name: name parameters: parameters_key: parameters_key report_type: report_type rerun: true scopes: - CLIENT_ADMIN sftp_report_name: sftp_report_name sftp_server_id: sftp_server_id tags: - tag schema: $ref: '#/components/schemas/CreateReportRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_display_name_empty: $ref: '#/components/examples/report_display_name_empty' report_display_name_too_long: $ref: '#/components/examples/report_display_name_too_long' report_invalid_formats: $ref: '#/components/examples/report_invalid_formats' report_invalid_operation: $ref: '#/components/examples/report_invalid_operation' report_invalid_parameter: $ref: '#/components/examples/report_invalid_parameter' report_invalid_scopes: $ref: '#/components/examples/report_invalid_scopes' report_invalid_sftp_server: $ref: '#/components/examples/report_invalid_sftp_server' report_missing_aggregation_parameter: $ref: '#/components/examples/report_missing_aggregation_parameter' report_missing_parameters: $ref: '#/components/examples/report_missing_parameters' report_name_illegal_character: $ref: '#/components/examples/report_name_illegal_character' report_tags_too_long: $ref: '#/components/examples/report_tags_too_long' report_type_missing: $ref: '#/components/examples/report_type_missing' report_type_not_found: $ref: '#/components/examples/report_type_not_found' report_update_invalid: $ref: '#/components/examples/report_update_invalid' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Create a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports-tags: get: description: Returns the list of tags available for filtering reports. operationId: listReportTags parameters: - in: query name: having_any_tags schema: type: string - in: query name: exclude_having_any_tags schema: type: string responses: '200': content: application/json: schema: items: type: string type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_limit: $ref: '#/components/examples/invalid_limit' invalid_offset: $ref: '#/components/examples/invalid_offset' invalid_parameter: $ref: '#/components/examples/invalid_parameter' max_fetch_size_1000: $ref: '#/components/examples/max_fetch_size_1000' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: List report tags tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/latest: get: description: Returns the most recent completed report run matching the specified report name and optional parameter filters. operationId: getLatestReport parameters: - in: query name: having_any_tags schema: type: string - in: query name: having_all_tags schema: type: string - in: query name: exclude_having_any_tags schema: type: string - in: query name: exclude_having_all_tags schema: type: string - in: query name: order_by schema: enum: - DATE_COMPLETED - DATE_RUN - NAME - STATUS - USER type: string - in: query name: order schema: enum: - ASCENDING - DESCENDING type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_content_by_tags_not_found: $ref: '#/components/examples/report_content_by_tags_not_found' report_content_format_by_tags_not_found: $ref: '#/components/examples/report_content_format_by_tags_not_found' report_content_format_not_found: $ref: '#/components/examples/report_content_format_not_found' report_content_not_found: $ref: '#/components/examples/report_content_not_found' report_content_not_supported: $ref: '#/components/examples/report_content_not_supported' report_filter_missing: $ref: '#/components/examples/report_filter_missing' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Get the latest report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/latest/download{format}: get: description: Downloads the output of the most recent completed report run matching the specified report name and optional filters. Append a format extension to select the download format. operationId: downloadLatestReport parameters: - in: header name: Content-Type schema: type: string - in: path name: format required: true schema: nullable: true pattern: (\.csv|\.json|\.jsonl|\.xlsx|\.psv|\.headless_csv|\.headless_psv)? type: string - in: query name: having_any_tags schema: type: string - in: query name: having_all_tags schema: type: string - in: query name: exclude_having_any_tags schema: type: string - in: query name: exclude_having_all_tags schema: type: string - in: query name: order_by schema: enum: - DATE_COMPLETED - DATE_RUN - NAME - STATUS - USER type: string - in: query name: order schema: enum: - ASCENDING - DESCENDING type: string - in: query name: offset schema: type: string - in: query name: limit schema: type: string - in: query name: filename schema: type: string responses: '200': content: '*/*': {} description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_limit: $ref: '#/components/examples/invalid_limit' invalid_offset: $ref: '#/components/examples/invalid_offset' invalid_parameter: $ref: '#/components/examples/invalid_parameter' max_fetch_size_1000: $ref: '#/components/examples/max_fetch_size_1000' missing_request_body: $ref: '#/components/examples/missing_request_body' report_content_by_tags_not_found: $ref: '#/components/examples/report_content_by_tags_not_found' report_content_format_by_tags_not_found: $ref: '#/components/examples/report_content_format_by_tags_not_found' report_content_format_not_found: $ref: '#/components/examples/report_content_format_not_found' report_content_not_found: $ref: '#/components/examples/report_content_not_found' report_content_not_supported: $ref: '#/components/examples/report_content_not_supported' report_filter_missing: $ref: '#/components/examples/report_filter_missing' report_not_found: $ref: '#/components/examples/report_not_found' report_preview_not_available: $ref: '#/components/examples/report_preview_not_available' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Download the latest report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/recommendations: get: description: Returns reports recommended for scheduling according to the selected recommendation type. operationId: listReportRecommendations parameters: - description: 'Recommendation type, can be one of: SCHEDULE' in: query name: type schema: enum: - SCHEDULE type: string - description: Optional filter for limit, defaults to 4. in: query name: limit schema: type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ReportResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_limit: $ref: '#/components/examples/invalid_limit' invalid_offset: $ref: '#/components/examples/invalid_offset' invalid_parameter: $ref: '#/components/examples/invalid_parameter' max_fetch_size_1000: $ref: '#/components/examples/max_fetch_size_1000' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: List report recommendations tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}: get: description: Returns the status and metadata for the report run identified by its report ID. operationId: getReport parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_not_found: $ref: '#/components/examples/report_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Get a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible put: description: Updates the parameters of a pending report run identified by its report ID. operationId: updateReport parameters: - in: path name: reportId required: true schema: type: string requestBody: content: application/json: example: display_name: display_name scopes: - CLIENT_ADMIN tags: - tag visible: true schema: $ref: '#/components/schemas/UpdateReportRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_display_name_empty: $ref: '#/components/examples/report_display_name_empty' report_display_name_too_long: $ref: '#/components/examples/report_display_name_too_long' report_invalid_formats: $ref: '#/components/examples/report_invalid_formats' report_invalid_operation: $ref: '#/components/examples/report_invalid_operation' report_invalid_parameter: $ref: '#/components/examples/report_invalid_parameter' report_invalid_scopes: $ref: '#/components/examples/report_invalid_scopes' report_invalid_sftp_server: $ref: '#/components/examples/report_invalid_sftp_server' report_missing_aggregation_parameter: $ref: '#/components/examples/report_missing_aggregation_parameter' report_missing_parameters: $ref: '#/components/examples/report_missing_parameters' report_name_illegal_character: $ref: '#/components/examples/report_name_illegal_character' report_not_found: $ref: '#/components/examples/report_not_found' report_tags_too_long: $ref: '#/components/examples/report_tags_too_long' report_type_missing: $ref: '#/components/examples/report_type_missing' report_update_invalid: $ref: '#/components/examples/report_update_invalid' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Update a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible delete: description: Deletes the report run identified by its report ID, including its output data. operationId: deleteReport parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_not_found: $ref: '#/components/examples/report_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Delete a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/debug: get: description: Returns internal debug information for the report run identified by its report ID. Restricted to client superusers. operationId: getReportDebug parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportDebugResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_not_found: $ref: '#/components/examples/report_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Get report debug info tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/download{format}: get: description: Downloads the output of a completed report run. Append a format extension (`.csv`, `.json`, `.jsonl`, `.xlsx`, `.psv`) to select the download format, or omit it to use the report's default format. operationId: downloadReport parameters: - in: header name: Content-Type schema: nullable: true type: string - in: path name: reportId required: true schema: type: string - in: path name: format required: true schema: nullable: true pattern: (\.csv|\.json|\.jsonl|\.xlsx|\.psv|\.headless_csv|\.headless_psv)? type: string - in: query name: limit schema: nullable: true type: string - in: query name: offset schema: nullable: true type: string - in: query name: filename schema: nullable: true type: string responses: '200': content: '*/*': {} description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_limit: $ref: '#/components/examples/invalid_limit' invalid_offset: $ref: '#/components/examples/invalid_offset' invalid_parameter: $ref: '#/components/examples/invalid_parameter' max_fetch_size_1000: $ref: '#/components/examples/max_fetch_size_1000' missing_request_body: $ref: '#/components/examples/missing_request_body' report_content_by_tags_not_found: $ref: '#/components/examples/report_content_by_tags_not_found' report_content_format_by_tags_not_found: $ref: '#/components/examples/report_content_format_by_tags_not_found' report_content_format_not_found: $ref: '#/components/examples/report_content_format_not_found' report_content_not_found: $ref: '#/components/examples/report_content_not_found' report_content_not_supported: $ref: '#/components/examples/report_content_not_supported' report_filter_missing: $ref: '#/components/examples/report_filter_missing' report_not_found: $ref: '#/components/examples/report_not_found' report_preview_not_available: $ref: '#/components/examples/report_preview_not_available' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Download a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/info: get: description: Returns metadata about a completed report across all available formats, including row count and available column sets. operationId: getReportInfo parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportInfoResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_content_by_tags_not_found: $ref: '#/components/examples/report_content_by_tags_not_found' report_content_format_by_tags_not_found: $ref: '#/components/examples/report_content_format_by_tags_not_found' report_content_format_not_found: $ref: '#/components/examples/report_content_format_not_found' report_content_not_found: $ref: '#/components/examples/report_content_not_found' report_content_not_supported: $ref: '#/components/examples/report_content_not_supported' report_filter_missing: $ref: '#/components/examples/report_filter_missing' report_not_found: $ref: '#/components/examples/report_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Get report info tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/info/{format}: get: description: Returns metadata about a completed report in the specified format, such as row count and column names. operationId: getReportInfoByFormat parameters: - in: path name: reportId required: true schema: type: string - in: path name: format required: true schema: pattern: (csv|json|jsonl|xlsx|psv|headless_csv|headless_psv) type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FormatReportInfoResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_content_by_tags_not_found: $ref: '#/components/examples/report_content_by_tags_not_found' report_content_format_by_tags_not_found: $ref: '#/components/examples/report_content_format_by_tags_not_found' report_content_format_not_found: $ref: '#/components/examples/report_content_format_not_found' report_content_not_found: $ref: '#/components/examples/report_content_not_found' report_content_not_supported: $ref: '#/components/examples/report_content_not_supported' report_filter_missing: $ref: '#/components/examples/report_filter_missing' report_not_found: $ref: '#/components/examples/report_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Get report format info tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/views/public: get: description: Returns the publicly accessible view of the specified report. operationId: getPublicReportView parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_not_found: $ref: '#/components/examples/report_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Get public view of a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/cancel: post: description: Cancels a pending or in-progress report run identified by its report ID. operationId: cancelReport parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_display_name_empty: $ref: '#/components/examples/report_display_name_empty' report_display_name_too_long: $ref: '#/components/examples/report_display_name_too_long' report_invalid_formats: $ref: '#/components/examples/report_invalid_formats' report_invalid_operation: $ref: '#/components/examples/report_invalid_operation' report_invalid_parameter: $ref: '#/components/examples/report_invalid_parameter' report_invalid_scopes: $ref: '#/components/examples/report_invalid_scopes' report_invalid_sftp_server: $ref: '#/components/examples/report_invalid_sftp_server' report_missing_aggregation_parameter: $ref: '#/components/examples/report_missing_aggregation_parameter' report_missing_parameters: $ref: '#/components/examples/report_missing_parameters' report_name_illegal_character: $ref: '#/components/examples/report_name_illegal_character' report_not_found: $ref: '#/components/examples/report_not_found' report_tags_too_long: $ref: '#/components/examples/report_tags_too_long' report_type_missing: $ref: '#/components/examples/report_type_missing' report_update_invalid: $ref: '#/components/examples/report_update_invalid' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Cancel a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/retry: post: description: Retries a previously submitted report run identified by its report ID. Use this to re-run a failed or cancelled report with the same parameters. operationId: retryReport parameters: - in: path name: reportId required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' report_not_found: $ref: '#/components/examples/report_not_found' report_type_not_found: $ref: '#/components/examples/report_type_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Retry a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible /v4/reports/{reportId}/sharedToken: post: description: Creates a shareable access token for the specified report, allowing the report to be accessed without full authentication. operationId: createReportSharedToken parameters: - in: path name: reportId required: true schema: type: string requestBody: content: application/json: example: duration_seconds: 1 schema: $ref: '#/components/schemas/ReportSharedTokenCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportSharedTokenResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_duration: $ref: '#/components/examples/invalid_duration' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' no_such_resource: $ref: '#/components/examples/no_such_resource' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Create a shared token for a report tags: - Reports x-extole-bundle: management x-extole-visibility: visible components: examples: report_type_missing: summary: report_type_missing value: code: report_type_missing http_status_code: 400 message: Report type is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_not_found: summary: report_not_found value: code: report_not_found http_status_code: 400 message: Report not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_display_name_empty: summary: report_display_name_empty value: code: report_display_name_empty http_status_code: 400 message: Report display name is empty parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_type_not_found: summary: report_type_not_found value: code: report_type_not_found http_status_code: 400 message: Report type referenced by the component is not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_content_format_by_tags_not_found: summary: report_content_format_by_tags_not_found value: code: report_content_format_by_tags_not_found http_status_code: 400 message: Report content format by tags not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_invalid_operation: summary: report_invalid_operation value: code: report_invalid_operation http_status_code: 400 message: Current report state doesn't allow the specified operation parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_offset: summary: invalid_offset value: code: invalid_offset http_status_code: 400 message: Offset should be a non negative integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_filter_missing: summary: report_filter_missing value: code: report_filter_missing http_status_code: 400 message: Report tags is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_missing_aggregation_parameter: summary: report_missing_aggregation_parameter value: code: report_missing_aggregation_parameter http_status_code: 400 message: Report must have at least one aggregating function parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_preview_not_available: summary: report_preview_not_available value: code: report_preview_not_available http_status_code: 400 message: Report preview for requested format is not available parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_timerange_format: summary: invalid_timerange_format value: code: invalid_timerange_format http_status_code: 400 message: Time range is not of a valid ISO_8601 format parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_content_not_supported: summary: report_content_not_supported value: code: report_content_not_supported http_status_code: 400 message: Report content type not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 no_such_resource: summary: no_such_resource value: code: no_such_resource http_status_code: 400 message: The resource could not be found. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_update_invalid: summary: report_update_invalid value: code: report_update_invalid http_status_code: 400 message: Report update invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_content_not_found: summary: report_content_not_found value: code: report_content_not_found http_status_code: 400 message: Report content exceed max size parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_missing_parameters: summary: report_missing_parameters value: code: report_missing_parameters http_status_code: 400 message: Report is missing parameters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_invalid_parameter: summary: report_invalid_parameter value: code: report_invalid_parameter http_status_code: 400 message: Report parameter(s) of invalid format parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_duration: summary: invalid_duration value: code: invalid_duration http_status_code: 400 message: The requested duration for this token must end within the first ten millenium parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_content_by_tags_not_found: summary: report_content_by_tags_not_found value: code: report_content_by_tags_not_found http_status_code: 400 message: Report content by tags could not be downloaded parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_invalid_scopes: summary: report_invalid_scopes value: code: report_invalid_scopes http_status_code: 400 message: Report scopes invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_invalid_sftp_server: summary: report_invalid_sftp_server value: code: report_invalid_sftp_server http_status_code: 400 message: Invalid SFTP server parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_display_name_too_long: summary: report_display_name_too_long value: code: report_display_name_too_long http_status_code: 400 message: Report display name is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_name_illegal_character: summary: report_name_illegal_character value: code: report_name_illegal_character http_status_code: 400 message: Report name can only contain alphanumeric, space, dash, parenthesis, slash, colon, comma, period, underscore, dollar and percentage parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_invalid_formats: summary: report_invalid_formats value: code: report_invalid_formats http_status_code: 400 message: Report formats not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_tags_too_long: summary: report_tags_too_long value: code: report_tags_too_long http_status_code: 400 message: Tags are too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_limit: summary: invalid_limit value: code: invalid_limit http_status_code: 400 message: Limit should be a non negative integer parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_content_format_not_found: summary: report_content_format_not_found value: code: report_content_format_not_found http_status_code: 400 message: Report content format not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 max_fetch_size_1000: summary: max_fetch_size_1000 value: code: max_fetch_size_1000 http_status_code: 400 message: Maximum allowed difference between limit and offset should be 1000 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 schemas: ReportSharedTokenCreateRequest: description: Body of a `POST /v4/reports/{reportId}/sharedToken` request. properties: duration_seconds: format: int64 type: integer type: object ReportSharedTokenResponse: properties: access_token: type: string expires_in: format: int64 type: integer required: - access_token - expires_in type: object ReportParameterDetailsResponse: properties: category: nullable: true type: string display_name: type: string is_required: type: boolean name: type: string order: format: int32 type: integer type: $ref: '#/components/schemas/ReportParameterTypeResponse' type: object FormatReportInfoResponse: properties: content_length: format: int64 type: integer total_rows: format: int64 type: integer required: - content_length - total_rows type: object UpdateReportRequest: properties: display_name: type: string scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true tags: items: type: string type: array uniqueItems: true visible: type: boolean type: object ReportInfoResponse: properties: total_rows: format: int64 type: integer required: - total_rows type: object CreateReportRequest: properties: display_name: nullable: true type: string format: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX nullable: true type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string nullable: true type: array name: type: string parameters: additionalProperties: type: string type: object report_type: type: string rerun: nullable: true type: boolean scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string nullable: true type: array uniqueItems: true sftp_report_name: nullable: true type: string sftp_server_id: nullable: true type: string tags: items: type: string nullable: true type: array uniqueItems: true required: - display_name - format - formats - name - parameters - report_type - rerun - scopes - sftp_report_name - sftp_server_id - tags type: object ReportDebugResponse: properties: debug_message: nullable: true type: string error_code: nullable: true type: string error_message: nullable: true type: string report_id: type: string status: enum: - CANCELED - DONE - EXPIRED - FAILED - IN_PROGRESS - PENDING - PENDING_DATA - SFTP_DELIVERY_FAILED type: string required: - debug_message - error_code - error_message - report_id - status type: object PublicReportResponse: properties: created_date: $ref: '#/components/schemas/ZonedDateTime' display_name: type: string download_uri: type: string executor_type: enum: - DASHBOARD - SPARK - SQL type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array id: readOnly: true type: string parameters: additionalProperties: $ref: '#/components/schemas/ReportParameterResponse' type: object report_type: type: string result: $ref: '#/components/schemas/PublicReportResultResponse' scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true tags: items: type: string type: array uniqueItems: true user_id: type: string required: - created_date - display_name - download_uri - executor_type - formats - id - parameters - report_type - result - scopes - tags - user_id type: object ReportParameterResponse: properties: details: $ref: '#/components/schemas/ReportParameterDetailsResponse' value: type: string type: object ReportResponse: properties: completed_date: nullable: true type: string display_name: type: string download_uri: nullable: true type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array name: type: string report_id: type: string report_type: type: string tags: items: type: string type: array uniqueItems: true required: - completed_date - display_name - download_uri - formats - name - report_id - report_type - tags type: object ReportParameterTypeResponse: properties: name: enum: - AUDIENCE_ID - AUDIENCE_IDS - AUDIENCE_MEMBERSHIPS_METRIC_MAPPING - AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS - AUDIENCE_MEMBERS_ROW_MAPPINGS - BOOLEAN - CAMPAIGN_ID - CAMPAIGN_IDS - CHANNEL_MAPPING - CLIENT_EVENT_METRIC_MAPPINGS - CLIENT_ID - CLIENT_IDS - DATE - DATE_RANGE - DECIMAL - EMAIL_NAMES - ENUM - ENUM_LIST - EQUALITY - FILTER_MAPPINGS - FLOWS - FLOW_FILTER - GRANULAR_TIME_RANGE - ID - IDS - INPUT_RECORD_METRIC_MAPPING - INPUT_RECORD_ROW_MAPPINGS - INTEGER - LONG - MESSAGE_SUMMARY_METRIC_MAPPINGS - METRIC_MAPPINGS - MODEL_CONFIGURATION_METRIC_MAPPING - NORMALIZED_EMAIL - NOT_ARCHIVED_CAMPAIGN_ID - PERSON_DIMENSION_MAPPINGS - PERSON_MAPPINGS - PROGRAM_LABEL - PROGRAM_LABELS - REGEX - REWARD_EVENT_METRIC_MAPPINGS - REWARD_ROW_MAPPINGS - REWARD_SUPPLIER_DISPLAY_TYPES - REWARD_SUPPLIER_IDS - REWARD_SUPPLIER_TYPES - ROW_MAPPINGS - SORT_ORDER_MAPPINGS - SORT_ORDER_MAPPINGS_ON_STEPS - STEP - STEPS - STEP_COLUMN_LIST - STRING - STRING_LIST - TIERS - TIME - TIME_RANGE - WEBHOOK_DISPATCH_METRIC_MAPPING - WEBHOOK_DISPATCH_ROW_MAPPINGS - WEBHOOK_METRIC_MAPPING - WEBHOOK_ROW_MAPPINGS type: string value_type: enum: - DYNAMIC - STATIC nullable: true type: string values: items: type: string nullable: true type: array uniqueItems: true type: object ZonedDateTime: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.' example: '2025-10-24T02:00:00-07:00' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: Attributes related to the error, varies be error code, documented per endpoint type: object description: Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object PublicReportResultResponse: properties: completed_date: $ref: '#/components/schemas/ZonedDateTime' formats_info: additionalProperties: $ref: '#/components/schemas/FormatReportInfoResponse' type: object started_date: $ref: '#/components/schemas/ZonedDateTime' status: enum: - CANCELED - DONE - EXPIRED - FAILED - IN_PROGRESS - PENDING - PENDING_DATA - SFTP_DELIVERY_FAILED type: string total_rows: format: int64 type: integer type: object securitySchemes: COOKIE: in: cookie name: extole_token type: apiKey HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey x-tagGroups: - name: Integration API - Consumer to Extole tags: - Authentication - Content - Email - Events - Persons - Profile Assets - Profiles