Edit in GitHubLog an issue

Job definition reference

A JSON request body is required when creating a Data Repair API job. This page provides a full list of variables, actions, and filters that you can include to create a valid JSON request body.

Structure#

A JSON request body consists of one or more variables with the desired action for each variable. You can also optionally include a filter for a given variable.

Copied to your clipboard
1{
2 "variables": {
3 "{VARIABLE_1}": {
4 "action": "{ACTION_1}",
5 "filter": {"condition": "{CONDITION_1}"}
6 },
7 "{VARIABLE_2}": {
8 "action": "{ACTION_2}"
9 }
10 }
11}

Variables#

The Data Repair API supports the following variables, with their supported actions.

  • If a variable supports the set action, you can use any filter with it unless otherwise noted.
  • If a variable supports the delete action, you can use any filter except isEmpty with it unless otherwise noted.
  • If a variable supports deleteQueryString or deleteQueryStringParameters, you cannot use any filters with either action.
VariableSupported actionsDescription
activitymapdeleteDeletes all Activity map data for the hit. This variable does not support any filters.
campaignset
delete
deleteQueryString
deleteQueryStringParameters
The Tracking code dimension. Only tracking codes with an expiration of page view, visit, or time period of 1 day or shorter are supported by the Data Repair API. A data repair job fails if it includes this variable with an expiration of a time period greater than 1 day or on an event. As a best practice, Adobe recommends resetting the tracking code before a data repair job runs so that values persisted by visitors do not reappear after a data repair job is complete.
entrypage
entrypageoriginal
set
delete
deleteQueryString
deleteQueryStringParameters
The Entry page dimension.
evar1 - evar250set
delete
deleteQueryString
deleteQueryStringParameters
eVar dimensions. Only eVars with an expiration of page view, visit, or time period of 1 day or shorter are supported by the Data Repair API. Merchandising variables, enabled currently or historically, are not supported. As a best practice, Adobe recommends resetting the eVar in question before a data repair job runs so that values persisted by visitors do not reappear after a data repair job is complete.
geodmadeleteThe US DMA dimension. The only supported filter is inList.
geocitydeleteThe Cities dimension. The only supported filter is inList.
geocountrydeleteThe Countries dimension. The only supported filter is inList.
geolatitude
geolongitude
deleteThe only supported filter is inList.
georegiondeleteThe Regions dimension. The only supported filter is inList.
geozipdeleteThe Zip code dimension collected through geolocation. See also zip. The only supported filter is inList.
ipaddressdeleteThe IP address of the visitor. The only supported filter is inList.
latitude
longitude
deleteThe only supported filter is inList.
latlon1
latlon23
latlon45
pointofinterest
pointofinterestdistance
deleteMobile dimensions. These variables do not support any filters.
mobileactiondeleteThe Mobile action dimension.
mobileappid
mobilemessagebuttonname
mobilemessageid
mobilerelaunchcampaigncontent
mobilerelaunchcampaignmedium
mobilerelaunchcampaignsource
mobilerelaunchcampaignterm
mobilerelaunchcampaigntrackingcode
set
delete
deleteQueryString
deleteQueryStringParameters
Mobile dimensions. If using the delete action with this variable, no filters are supported. Standard filters are supported when using the set action with this variable.
pageset
deleteQueryString
deleteQueryStringParameters
The Page dimension. The isEmpty filter is not supported.
pageeventvar1set
deleteQueryString
deleteQueryStringParameters
The linkURL implementation variable. The isEmpty filter is not supported.
pageeventvar2set
deleteQueryString
deleteQueryStringParameters
The Download link, Exit link, or Custom link dimension, depending on the type of link. The isEmpty filter is not supported.
pageurldeleteQueryString
deleteQueryStringParameters
The Page URL dimension.
pageurlfirsthit
pageurlvisitstart
deleteQueryString
deleteQueryStringParameters
N/A
prop1 - prop75set
delete
deleteQueryString
deleteQueryStringParameters
Prop dimensions.
referrerdeleteQueryString
deleteQueryStringParameters
The Referrer dimension.
referrerfirsthit
referrervisit
deleteQueryString
deleteQueryStringParameters
N/A
sitesectionsset
delete
deleteQueryString
deleteQueryStringParameters
The Site section dimension.
video
videoad
set
deleteQueryString
deleteQueryStringParameters
Media Analytics dimensions.
videoadname
videoadplayername
videoadadvertiser
videoaudioalbum
videoaudioartist
videoaudioauthor
videoaudiolabel
videoaudiopublisher
videoaudiostation
videoadcampaign
videochannel
videochapter
videocontenttype
videoepisode
videofeedtype
videomvpd
videoname
videonetwork
videopath
videoplayername
videoseason
videoshow
videoshowtype
videostreamtype
set
delete
deleteQueryString
deleteQueryStringParameters
Media Analytics dimensions.
zipdeleteThe Zip code dimension collected through the zip variable (not geosegmentation). See also geozip. The only supported filter is inList.

Actions#

Each variable requires an action. The Data Repair API supports the following four actions:

  • set: Overwrites the variable to the value in the setValue property. Include the setValue property alongside the action property inside the variable. It supports all filters by default; however, some variables do not support all filters for this action. See the above table to confirm that a variable supports a filter with this action.
  • delete: Clears the variable value. It supports all filters except isEmpty by default. Some variables do not support all filters for this action. See the above table to confirm that a variable supports a filter with this action.
  • deleteQueryString: Remove the entire query string from a variable value. If the value does not appear to be a URL, no action is taken. Filters are not supported with this action.
  • deleteQueryStringParameters: Remove one or more query string parameters and their values from a variable. The query parameters removed are based on the string array parameters. Include the parameters array alongside the action property inside the variable.
    • Up to 10 parameters are supported.
    • Parameters are case sensitive.
    • Filters are not supported with this action.
    • If the value is not a correctly formatted URL, no action is taken.
Copied to your clipboard
1{
2 "variables": {
3 "evar1": {
4 "action": "set",
5 "setValue": "New value"
6 }
7 }
8}

Filters#

The set and delete actions support filters, which allow you to selectively repair certain rows based on the filter criteria. Check the above variable table to make sure that an action supports the desired filter. The deleteQueryString and deleteQueryStringParameters actions do not support any filters.

All filters are currently case sensitive. Support for filters that are not case sensitive is planned.

  • inList: Include all rows where the variable is an exact match to at least one value from the matchValues array. The matchValues array can hold up to 1000 values.
  • isEmpty: Only include rows where the variable does not contain a value. Cannot be used with the delete action.
  • contains: Include rows where the variable contains the value in matchValue.
  • doesNotContain: Include rows where the value in matchValue is not present.
  • startsWith: Limit the action to rows where the value starts with the value in matchValue.
  • doesNotStartWith: Limit the action to rows where the value does not start with the value in matchValue.
  • endsWith: Limit the action to rows where the value ends with the value in matchValue.
  • doesNotEndWith: Limit the action to rows where the value does not end with the value in matchValue.
  • isURL: Only include the row if the Data Repair API recognizes the value as a URL.
  • isNotURL: Only include the row if the Data Repair API recognizes that the value is not a URL.
Copied to your clipboard
1{
2 "variables": {
3 "evar1": {
4 "action": "delete",
5 "filter": {
6 "condition": "inList",
7 "matchValues": ["match1", "match2"]
8 }
9 }
10 }
11}

Example Data Repair API definition file#

The following Data Repair API definition simultaneously performs the following four actions:

  • Deletes all activity map data
  • Deletes the value in prop12 across all rows
  • Sets eVar74 to the value of "Turtles" across all rows
  • Deletes the value in eVar107 if the existing eVar value contains "Fox" or "Dog"
Copied to your clipboard
1{
2 "variables": {
3 "activitymap": {
4 "action": "delete"
5 },
6 "prop12": {
7 "action": "delete"
8 },
9 "evar74": {
10 "action": "set",
11 "setValue": "Turtles"
12 },
13 "evar107": {
14 "action": "delete",
15 "filter": {
16 "condition": "inList",
17 "matchValues": ["Fox", "Dog"]
18 }
19 }
20 }
21}

Once you have a completed JSON request body and a validationToken from the Server Call estimate endpoint, you can make a call to the Job endpoint to make the Data Repair API call.

  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.