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 filters for a given variable.

Copy
{
  "variables": {
    "{VARIABLE_1}": {
      "action": "{ACTION_1}"
    },
    "{VARIABLE_2}": {
      "action": "{ACTION_2}",
      "filter": {"condition":  "{CONDITION_2}"}
    },
    "{VARIABLE_3}": {
      "action": "{ACTION_3}",
      "filters": [
        {"condition":  "{CONDITION_1}"},
        {"condition":  "{CONDITION_2}"}
      ]
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "{VARIABLE_1}": {
      "action": "{ACTION_1}"
    },
    "{VARIABLE_2}": {
      "action": "{ACTION_2}",
      "filter": {"condition":  "{CONDITION_2}"}
    },
    "{VARIABLE_3}": {
      "action": "{ACTION_3}",
      "filters": [
        {"condition":  "{CONDITION_1}"},
        {"condition":  "{CONDITION_2}"}
      ]
    }
  }
}

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.

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.

Copy
{
  "variables": {
    "evar1": {
      "action": "set",
      "setValue": "New value"
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "set",
      "setValue": "New value"
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "delete"
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete"
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "deleteQueryString"
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "deleteQueryString"
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "deleteQueryStringParameters",
      "parameters": ["param1", "param2"]
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "deleteQueryStringParameters",
      "parameters": ["param1", "param2"]
    }
  }
}

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.

You can specify a single filter using filter or multiple filters using filters. Matching one of multiple filters (using an 'OR' operator) is not supported; when using multiple filters, each row must match all filters to be included in the repair.

All filters are case-sensitive.

• 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.
• isNumeric: Include rows where the variable contains only numbers (0-9).
• isNotNumeric: Include rows where the variable contains characters other than numbers.

Copy
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "inList",
        "matchValues": ["match1", "match2"]
      }
    },
    "evar2": {
      "action": "delete",
      "filters": [{
        "condition": "inList",
        "matchValues": ["match1", "match2"]
      }, {
        "condition": "inList",
        "matchValues": ["match2", "match3"]
      }]
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "inList",
        "matchValues": ["match1", "match2"]
      }
    },
    "evar2": {
      "action": "delete",
      "filters": [{
        "condition": "inList",
        "matchValues": ["match1", "match2"]
      }, {
        "condition": "inList",
        "matchValues": ["match2", "match3"]
      }]
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "set", 
      "setValue": "new value", 
      "filter": {
        "condition": "isEmpty"
      }
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "set", 
      "setValue": "new value", 
      "filter": {
        "condition": "isEmpty"
      }
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "contains",
        "matchValue": "@"
      }
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "contains",
        "matchValue": "@"
      }
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "startsWith",
        "matchValue": "ABC"
      }
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "startsWith",
        "matchValue": "ABC"
      }
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "endsWith",
        "matchValue": "XYZ"
      }
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "endsWith",
        "matchValue": "XYZ"
      }
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "isURL"
      }
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "isURL"
      }
    }
  }
}

Copy
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "isNumeric"
      }
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "evar1": {
      "action": "delete",
      "filter": {
        "condition": "isNumeric"
      }
    }
  }
}

Filter Variables

By default, a filter is applied to the variable being repaired. Use filter.variable to filter by a variable other than the target variable. For example, the following means delete evar2 where evar3 contains '@':

Copy
{
  "evar2": {
    "action": "delete",
    "filter": {
      "condition": "contains",
      "matchValue": "@",
      "variable": "evar3"
    }
  }
}
Copied to your clipboard
{
  "evar2": {
    "action": "delete",
    "filter": {
      "condition": "contains",
      "matchValue": "@",
      "variable": "evar3"
    }
  }
}

Example Data Repair API definition file

The following Data Repair API definition simultaneously performs the following five 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"
• Deletes the value in evar110 where evar110 starts with Horse AND evar111 starts with Zebra

Copy
{
  "variables": {
    "activitymap": {
      "action": "delete"
    },
    "prop12": {
      "action": "delete"
    },
    "evar74": {
      "action": "set",
      "setValue": "Turtles"
    },
    "evar107": {
      "action": "delete",
      "filter": {
        "condition": "inList",
        "matchValues": ["Fox", "Dog"]
      }
    },
    "evar110": {
      "action": "delete",
      "filters": [{
        "condition": "startsWith",
        "matchValue": "Horse"
      }, {
        "condition": "startsWith",
        "matchValue": "Zebra",
        "variable": "evar111"
      }]
    }
  }
}
Copied to your clipboard
{
  "variables": {
    "activitymap": {
      "action": "delete"
    },
    "prop12": {
      "action": "delete"
    },
    "evar74": {
      "action": "set",
      "setValue": "Turtles"
    },
    "evar107": {
      "action": "delete",
      "filter": {
        "condition": "inList",
        "matchValues": ["Fox", "Dog"]
      }
    },
    "evar110": {
      "action": "delete",
      "filters": [{
        "condition": "startsWith",
        "matchValue": "Horse"
      }, {
        "condition": "startsWith",
        "matchValue": "Zebra",
        "variable": "evar111"
      }]
    }
  }
}

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.

Last updated 2/27/2024

Was this helpful?

Yes

No