DataShopper API Documentation

Welcome to the DataShopper API! Our API allows you to leverage the power of data-driven solutions to identify anonymous website visitors, retarget users, and optimize your marketing strategies. This documentation provides detailed information on how to use our API effectively.

Pii Append Type Request and Response

Endpoint: https://main.dashboard.datashopper.com/api/v1/GetDataBy/Pii

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of website.
object_listarrayContains the Pii(s) (First Name, Last Name, Address, Zip, Sequence as defined by user)

Example Body Request:

{
  "api_key":"your-api-key-here",
  "website":"your-website-slug",
  "object_list": [
    {
      "FirstName":"EMMA",
      "LastName":"JOHNSON",
      "Address":"379 Main Ln",
      "Zip":"90210",
      "Sequence":"123xyz"
    }
  ]
}

Example Body Response:

{
  "success": true,
  "data": {
    "requestId": "your-website-slug",
    "returnData": {
      "123xyz": [
        {
          "Id": "1924395570",
          "Address": "379 Main Ln",
          "City": "Beverly Hills",
          "First_Name": "Emma",
          "Last_Name": "Johnson",
          "State": "CA",
          "Zip": "90210",
          "NationalConsumerDatabase": "1",
          "Email_Array": [
            "[email protected]",
            "[email protected]"
          ],
          "Phone_Array": [
            "9513925555"
          ],
          "Sequence": "123xyz"
        }
      ]
    }
  }  
}

Phone Append Type Request and Response

Endpoint: https://main.dashboard.datashopper.com/api/v1/GetDataBy/Phone

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of website.
object_listarrayContains the Phone number(s)

Example Body Request:

{
  "api_key":"your-api-key-here",
  "website":"your-website-slug",
  "object_list":["9513925555"]
}

Example Body Response:

{
  "success": true,\
  "data": {
    "requestId": "your-website-slug",
    "returnData": {
      "9513925555": [
        {
          "Id": "1924395570",
          "Address": "379 Main Ln",
          "City": "Beverly Hills",
          "First_Name": "Emma",
          "Last_Name": "Johnson",
          "State": "CA",
          "Zip": "90210",
          "NationalConsumerDatabase": "1",
          "Email_Array": [
            "[email protected]",
            "[email protected]"
          ],
          "Phone_Array": [
            "9513925555"
          ],
          "Sequence": "123xyz"
        }
      ]
    }  
  }
}

Email Append Type Request and Response

Endpoint: https://main.dashboard.datashopper.com/api/v1/GetDataBy/Email

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of website.
object_listarrayContains the email address(es)

Example Body Request:

{
  "api_key":"your-api-key-here",
  "website":"your-website-slug",
  "object_list": ["[email protected]"]
}

Example Body Response:

{
  "success": true,
  "data": {
    "requestId": "your-website-slug",
    "returnData": {
      "[email protected]": [
        {
          "Id": "1924395570",
          "Address": "379 Main Ln",
          "City": "Beverly Hills",
          "First_Name": "Emma",
          "Last_Name": "Johnson",
          "State": "CA",
          "Zip": "90210",
          "NationalConsumerDatabase": "1",
          "Email_Array": [
            "[email protected]",
            "[email protected]"
          ],
          "Phone_Array": [
            "9513925555"
          ],
          "Sequence": "123xyz"
        }
      ]
    } 
  }
}

Md5 Append Type Request and Response

Endpoint: https://main.dashboard.datashopper.com/api/v1/GetDataBy/Md5

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of website.
object_listarrayContains the MD5 hashed email(s)

Example Body Request:

{
  "api_key":"your-api-key-here",
  "website":"your-website-slug",
  "object_list": ["b0899b86c0d408b55f5685560b16146c"]
}

Example Body Response:

{
  "success": true,
  "data": {
    "requestId": "your-website-slug",
    "returnData": {
      "b0899b86c0d408b55f5685560b16146c": [
        {
          "Id": "1924395570",
          "Address": "379 Main Ln",
          "City": "Beverly Hills",
          "First_Name": "Emma",
          "Last_Name": "Johnson",
          "State": "CA",
          "Zip": "90210",
          "NationalConsumerDatabase": "1",
          "Email_Array": [
            "[email protected]",
            "[email protected]"
          ],
          "Phone_Array": [
            "9513925555"
          ],
          "Sequence": "123xyz"
        }
      ]
    }
  }
}

Id Append Type Request and Response

Endpoint: https://main.dashboard.datashopper.com/api/v1/GetDataBy/Id

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of website.
object_listarrayContains the Datashopper Id(s)

Example Body Request:

{
  "api_key":"your-api-key-here",
  "website":"your-website-slug",
  "object_list": ["1924395570"]
}

Example Body Response:

{
  "success": true,
  "data": {
    "requestId": "your-website-slug",
    "returnData": {
      "1924395570": [
        {
          "Id": "1924395570",
          "Address": "379 Main Ln",
          "City": "Beverly Hills",
          "First_Name": "Emma",
          "Last_Name": "Johnson",
          "State": "CA",
          "Zip": "90210",
          "NationalConsumerDatabase": "1",
          "Email_Array": [
            "[email protected]",
            "[email protected]"
          ],
          "Phone_Array": [
            "9513925555"
          ],
          "Sequence": "123xyz"
        }
      ]
    }
  }
}

Get Results

Endpoint: https://main.dashboard.datashopper.com/api/v1/results

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of website.

Example Body Request:

{
    "api_key": "your-api-key",
    "website":"your-website-slug"
}

Create Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel

Request Type: POST

Body: raw

Parameter

Type

Description

api_key

string

Your unique API key provided by the Datashopper team.

name

string

The name of website.

url

string

The url of website.

filter

string

This field is optional, only attach for creating pixel for specific routes. It can either "include" or "exclude".

routes

array

An array comprising of specific routes on which the pixel should be executed. Each specific route must follow the format "/specific-path-name". Leave only "/" for homepage.

This field is optional, only attach for creating pixel for specific routes.

Example Body Request:

{
    "api_key": "your-api-key",
    "name":"website-name",
    "url": "https://www.website.com",
    "filter": "include",
    "routes": [
      "/",
      "/contact"
    ]
}

Get All Pixels

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.

Example Body Request:

{
    "api_key": "your-api-key"
}

Get a Pixel Script

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/your-website-slug

Request Type: GET

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.

Example Body Request:

{
    "api_key": "your-api-key"
}

Example Body Response:

<script>
    (function(){
        var e = document.getElementsByTagName("script")[0];
        var d = document.createElement("script");
        var date = new Date();
        var newDate = date.getFullYear() + '-' + String(date.getDate()).padStart(2, '0') + '-' + String(date.getHours()).padStart(2, '0');
        d.src = "https://some-website.com/script?request_id=your-website-slug&date=" + encodeURIComponent(newDate);
        d.type = "text/javascript";
        d.async = true;
        d.defer = true;
        e.parentNode.insertBefore(d, e);
    })();
<script>

Add/Update UTM Filters to a Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/utm-filters

Request Type: POST

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of your website.
campaign_sourcestringCampaign Source. This field is required.
campaign_mediumstringCampaign Medium. This field is required.
campaign_namestringCampaign Name. This field is optional.
campaign_termstringCampaign Term. This field is optional.
campaign_contentstringCampaign Content. This field is optional.

Example Body Request:

{
    "api_key": "your-api-key",
    "website":"website-name",
    "campaign_source": "source",
    "campaign_medium": "medium",
    "campaign_name": "name",
    "campaign_term": "term",
    "campaign_content": "content"
}

Add/Update Zip Code Filters to a Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/zip-codes

Request Type: POST

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of your website.
typestringThis field can either be "include" or "exclude" and will decide to include/exclude the specific zip codes.
zip_codesarrayThis array will contain the specific zip codes.

Example Body Request:

{
    "api_key": "your-api-key",
    "website":"website-name",
    "type": "include",
    "zip_codes": [
      "60021",
      "12345"
    ]
}

Create a Blacklist Filter for a Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/blacklist

Request Type: POST

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of your website.
namestringThe name of blacklist.
typestringThe type of blacklist, it can be either "email" or "address".
listarrayThis array will contain instances of either email or address.

Example Body Request:

{
    "api_key": "your-api-key",
    "website":"website-name",
    "name": "blacklist-name",
    "type": "email",
    "list": [
      "[email protected]",
      "[email protected]"
    ]
}

Delete UTM Filters for a Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/utm-filters

Request Type: DELETE

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of your website.

Delete Zip Code Filter for a Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/zip-codes

Request Type: DELETE

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of your website.

Delete a Blacklist Filter for a Pixel

Endpoint: https://main.dashboard.datashopper.com/api/v1/pixel/blacklist/blacklist-id

Request Type: DELETE

Body: raw

ParameterTypeDescription
api_keystringYour unique API key provided by the Datashopper team.
websitestringThe slug of your website.