Pii Append Type Request and Response

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

Request Type: POST

Header Setup: Content-Type: application/json

Body: raw

Parameter	Type	Description
api_key	string	Your unique API key provided by the Datashopper team.
website	string	The slug of website.
object_list	array	Contains 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:

{
  "website": "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: POST

Header Setup: Content-Type: application/json

Body: raw

Parameter	Type	Description
api_key	string	Your unique API key provided by the Datashopper team.
website	string	The slug of website.
object_list	array	Contains the Phone number(s)

Example Body Request:

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

Example Body Response:

{
  "website": "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: POST

Header Setup: Content-Type: application/json

Body: raw

Parameter	Type	Description
api_key	string	Your unique API key provided by the Datashopper team.
website	string	The slug of website.
object_list	array	Contains the email address(es)

Example Body Request:

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

Example Body Response:

{
  "website": "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: POST

Header Setup: Content-Type: application/json

Body: raw

Parameter	Type	Description
api_key	string	Your unique API key provided by the Datashopper team.
website	string	The slug of website.
object_list	array	Contains the MD5 hashed email(s)

Example Body Request:

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

Example Body Response:

{
  "website": "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: POST

Header Setup: Content-Type: application/json

Body: raw

Parameter	Type	Description
api_key	string	Your unique API key provided by the Datashopper team.
website	string	The slug of website.
object_list	array	Contains the Datashopper Id(s)

Example Body Request:

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

Example Body Response:

{
  "website": "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

Header Setup: Content-Type: application/json

Body: raw

Parameter	Type	Description
api_key	string	Your unique API key provided by the Datashopper team.
website	string	The slug of website.

Create Pixel

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

Request Type: POST

Header Setup: Content-Type: application/json

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.