openapi: 3.2.0 info: title: Data Repair Datarepair API description: 'Note: Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.' version: 1.0.0 servers: - url: https://analytics.adobe.io/api tags: - name: datarepair paths: /{globalCompanyId}/datarepair/v1/{reportSuiteId}/auth: get: operationId: get_auth_v1__reportSuiteId__auth_get parameters: - name: globalCompanyId in: path description: The Global Company ID for the Adobe Analytics organization required: true schema: type: string - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - in: path name: reportSuiteId required: true schema: title: Reportsuiteid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthResponseModel' description: Successful Response 4XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Client Error 5XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Server Error summary: Get Auth tags: - datarepair /{globalCompanyId}/datarepair/v1/{reportSuiteId}/job: get: operationId: get_jobs_v1__reportSuiteId__job_get parameters: - name: globalCompanyId in: path description: The Global Company ID for the Adobe Analytics organization required: true schema: type: string - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - in: path name: reportSuiteId required: true schema: title: Reportsuiteid type: string responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/DataRepairJobModel' title: Response Get Jobs V1 Reportsuiteid Job Get type: array description: Successful Response 4XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Client Error 5XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Server Error summary: Get Jobs tags: - datarepair post: operationId: create_job_v1__reportSuiteId__job_post parameters: - name: globalCompanyId in: path description: The Global Company ID for the Adobe Analytics organization required: true schema: type: string - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - in: path name: reportSuiteId required: true schema: title: Reportsuiteid type: string - in: query name: validationToken required: true schema: title: Validationtoken type: string - in: query name: validateOnly required: false schema: default: false title: Validateonly type: boolean - in: query name: dateRangeStart required: true schema: format: date title: Daterangestart type: string - in: query name: dateRangeEnd required: true schema: format: date title: Daterangeend type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobDefinitionModel' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/DataRepairJobModel' description: Successful Response '204': description: Empty response when validating a job 4XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Client Error 5XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Server Error summary: Create Job tags: - datarepair /{globalCompanyId}/datarepair/v1/{reportSuiteId}/job/{jobId}: get: operationId: get_job_v1__reportSuiteId__job__jobId__get parameters: - name: globalCompanyId in: path description: The Global Company ID for the Adobe Analytics organization required: true schema: type: string - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - in: path name: reportSuiteId required: true schema: title: Reportsuiteid type: string - in: path name: jobId required: true schema: title: Jobid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataRepairJobModel' description: Successful Response 4XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Client Error 5XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Server Error summary: Get Job tags: - datarepair /{globalCompanyId}/datarepair/v1/{reportSuiteId}/serverCallEstimate: get: operationId: get_server_call_estimate_v1__reportSuiteId__serverCallEstimate_get parameters: - name: globalCompanyId in: path description: The Global Company ID for the Adobe Analytics organization required: true schema: type: string - $ref: '#/components/parameters/authorization' - $ref: '#/components/parameters/x-api-key' - in: path name: reportSuiteId required: true schema: title: Reportsuiteid type: string - in: query name: dateRangeStart required: true schema: format: date title: Daterangestart type: string - in: query name: dateRangeEnd required: true schema: format: date title: Daterangeend type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServerCallEstimateResponseModel' description: Successful Response 4XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Client Error 5XX: content: application/json: schema: $ref: '#/components/schemas/ExceptionModel' description: Server Error summary: Get Server Call Estimate tags: - datarepair components: schemas: JobDefinitionStringContainsFilterModel: additionalProperties: false description: ' ' properties: condition: default: contains enum: - contains title: Condition type: string matchValue: title: Matchvalue type: string required: - matchValue title: JobDefinitionStringContainsFilterModel type: object JobDefinitionIsUrlFilterModel: additionalProperties: false description: ' ' properties: condition: default: isURL enum: - isURL title: Condition type: string title: JobDefinitionIsUrlFilterModel type: object JobDefinitionVariablesModel: additionalProperties: false description: ' ' properties: activitymap: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' campaign: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Campaign entrypage: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Entrypage entrypageoriginal: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Entrypageoriginal evar1: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Evar1 evar2: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Evar2 evar3: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Evar3 geocity: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' geocountry: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' geodma: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' geolatitude: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' geolongitude: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' georegion: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' geozip: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' ipaddress: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' latitude: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' latlon1: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' latlon23: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' latlon45: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' longitude: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' mobileaction: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' mobileappid: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobileappid mobilecampaigncontent: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilecampaigncontent mobilecampaignmedium: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilecampaignmedium mobilecampaignname: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilecampaignname mobilecampaignsource: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilecampaignsource mobilecampaignterm: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilecampaignterm mobilemessagebuttonname: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilemessagebuttonname mobilemessageid: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilemessageid mobilemessagepushoptin: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' mobilerelaunchcampaigncontent: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilerelaunchcampaigncontent mobilerelaunchcampaignmedium: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilerelaunchcampaignmedium mobilerelaunchcampaignsource: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilerelaunchcampaignsource mobilerelaunchcampaignterm: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilerelaunchcampaignterm mobilerelaunchcampaigntrackingcode: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Mobilerelaunchcampaigntrackingcode page: $ref: '#/components/schemas/JobDefinitionSetActionModel' pageeventvar1: $ref: '#/components/schemas/JobDefinitionSetActionModel' pageeventvar2: $ref: '#/components/schemas/JobDefinitionSetActionModel' pageurl: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringActionModel' - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringParametersActionModel' title: Pageurl pageurlfirsthit: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringActionModel' - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringParametersActionModel' title: Pageurlfirsthit pageurlvisitstart: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringActionModel' - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringParametersActionModel' title: Pageurlvisitstart pointofinterest: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' pointofinterestdistance: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' prop1: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Prop1 prop2: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Prop2 prop3: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Prop3 referrer: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringActionModel' - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringParametersActionModel' title: Referrer referrerfirsthit: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringActionModel' - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringParametersActionModel' title: Referrerfirsthit referrervisit: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringActionModel' - $ref: '#/components/schemas/JobDefinitionDeleteQueryStringParametersActionModel' title: Referrervisit sitesections: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Sitesections video: $ref: '#/components/schemas/JobDefinitionSetActionModel' videoad: $ref: '#/components/schemas/JobDefinitionSetActionModel' videoadname: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoadname videoadplayername: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoadplayername videoadvertiser: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoadvertiser videoaudioalbum: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoaudioalbum videoaudioartist: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoaudioartist videoaudioauthor: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoaudioauthor videoaudiolabel: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoaudiolabel videoaudiopublisher: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoaudiopublisher videoaudiostation: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoaudiostation videocampaign: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videocampaign videochannel: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videochannel videocontenttype: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videocontenttype videoepisode: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoepisode videofeedtype: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videofeedtype videomvpd: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videomvpd videoname: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoname videonetwork: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videonetwork videopath: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videopath videoplayername: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoplayername videoseason: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoseason videoshow: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoshow videoshowtype: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videoshowtype videostreamtype: anyOf: - $ref: '#/components/schemas/JobDefinitionDeleteActionModel' - $ref: '#/components/schemas/JobDefinitionSetActionModel' title: Videostreamtype zip: $ref: '#/components/schemas/JobDefinitionDeleteActionModel' title: JobDefinitionVariablesModel type: object JobDefinitionIsNotUrlFilterModel: additionalProperties: false description: ' ' properties: condition: default: isNotURL enum: - isNotURL title: Condition type: string title: JobDefinitionIsNotUrlFilterModel type: object JobDefinitionStringEndsWithFilterModel: additionalProperties: false description: ' ' properties: condition: default: endsWith enum: - endsWith title: Condition type: string matchValue: title: Matchvalue type: string required: - matchValue title: JobDefinitionStringEndsWithFilterModel type: object JobDefinitionStringStartsWithFilterModel: additionalProperties: false description: ' ' properties: condition: default: startsWith enum: - startsWith title: Condition type: string matchValue: title: Matchvalue type: string required: - matchValue title: JobDefinitionStringStartsWithFilterModel type: object JobDefinitionDeleteActionModel: additionalProperties: false description: ' ' properties: action: default: delete enum: - delete title: Action type: string filter: anyOf: - $ref: '#/components/schemas/JobDefinitionInListFilterModel' - $ref: '#/components/schemas/JobDefinitionStringStartsWithFilterModel' - $ref: '#/components/schemas/JobDefinitionStringEndsWithFilterModel' - $ref: '#/components/schemas/JobDefinitionStringContainsFilterModel' - $ref: '#/components/schemas/JobDefinitionStringContainsAtSignFilterModel' - $ref: '#/components/schemas/JobDefinitionIsUrlFilterModel' - $ref: '#/components/schemas/JobDefinitionIsNotUrlFilterModel' title: Filter title: JobDefinitionDeleteActionModel type: object JobDefinitionDeleteQueryStringActionModel: additionalProperties: false description: ' ' properties: action: default: deleteQueryString enum: - deleteQueryString title: Action type: string filter: $ref: '#/components/schemas/JobDefinitionBaseFilterModel' title: JobDefinitionDeleteQueryStringActionModel type: object ServerCallEstimateResponseModel: additionalProperties: false description: ' ' properties: dateRangeEnd: format: date title: Daterangeend type: string dateRangeStart: format: date title: Daterangestart type: string reportSuiteId: title: Reportsuiteid type: string serverCallEstimate: title: Servercallestimate type: integer validationToken: title: Validationtoken type: string required: - serverCallEstimate - reportSuiteId - validationToken - dateRangeStart - dateRangeEnd title: ServerCallEstimateResponseModel type: object DataRepairJobModel: additionalProperties: false description: ' ' properties: dateRangeEnd: format: date title: Daterangeend type: string dateRangeStart: format: date title: Daterangestart type: string jobCompleteTime: format: date-time title: Jobcompletetime type: string jobCreateTime: format: date-time title: Jobcreatetime type: string jobDefinition: $ref: '#/components/schemas/JobDefinitionModel' jobId: title: Jobid type: integer progress: title: Progress type: integer reportSuiteId: title: Reportsuiteid type: string serverCalls: title: Servercalls type: integer status: title: Status type: string required: - jobId - reportSuiteId - jobCreateTime - progress - status - dateRangeStart - dateRangeEnd - jobDefinition title: DataRepairJobModel type: object JobDefinitionInListFilterModel: additionalProperties: false description: ' ' properties: condition: default: inList enum: - inList title: Condition type: string matchValues: items: type: string title: Matchvalues type: array required: - matchValues title: JobDefinitionInListFilterModel type: object AuthResponseModel: additionalProperties: false description: ' ' properties: status: title: Status type: string required: - status title: AuthResponseModel type: object JobDefinitionStringContainsAtSignFilterModel: additionalProperties: false description: ' ' properties: condition: default: containsAtSign enum: - containsAtSign title: Condition type: string title: JobDefinitionStringContainsAtSignFilterModel type: object JobDefinitionDeleteQueryStringParametersActionModel: additionalProperties: false description: ' ' properties: action: default: deleteQueryStringParameters enum: - deleteQueryStringParameters title: Action type: string filter: $ref: '#/components/schemas/JobDefinitionBaseFilterModel' parameters: items: type: string title: Parameters type: array required: - parameters title: JobDefinitionDeleteQueryStringParametersActionModel type: object ExceptionModel: additionalProperties: false description: ' ' properties: errorCode: title: Errorcode type: string errorDescription: title: Errordescription type: string errorId: title: Errorid type: string required: - errorId - errorCode - errorDescription title: ExceptionModel type: object JobDefinitionSetActionModel: additionalProperties: false description: ' ' properties: action: default: set enum: - set title: Action type: string filter: anyOf: - $ref: '#/components/schemas/JobDefinitionInListFilterModel' - $ref: '#/components/schemas/JobDefinitionStringStartsWithFilterModel' - $ref: '#/components/schemas/JobDefinitionStringEndsWithFilterModel' - $ref: '#/components/schemas/JobDefinitionStringContainsFilterModel' - $ref: '#/components/schemas/JobDefinitionStringContainsAtSignFilterModel' - $ref: '#/components/schemas/JobDefinitionIsEmptyFilterModel' - $ref: '#/components/schemas/JobDefinitionIsUrlFilterModel' - $ref: '#/components/schemas/JobDefinitionIsNotUrlFilterModel' title: Filter setValue: title: Setvalue type: string required: - setValue title: JobDefinitionSetActionModel type: object JobDefinitionBaseFilterModel: additionalProperties: false description: ' ' properties: condition: title: Condition type: string required: - condition title: JobDefinitionBaseFilterModel type: object JobDefinitionModel: additionalProperties: false description: ' ' properties: variables: $ref: '#/components/schemas/JobDefinitionVariablesModel' required: - variables title: JobDefinitionModel type: object JobDefinitionIsEmptyFilterModel: additionalProperties: false description: ' ' properties: condition: default: isEmpty enum: - isEmpty title: Condition type: string title: JobDefinitionIsEmptyFilterModel type: object parameters: authorization: name: Authorization in: header description: The access token copied from your AA API client integration, prefixed with "Bearer ". required: true schema: type: string x-api-key: name: x-api-key in: header description: The API key copied from your AA API client integration. For more information on how to obtain this value, see [Getting started with the CJA API](https://developer.adobe.com/cja-apis/docs/getting-started/). required: true schema: type: string