Pixel

GET

http://datashopper.test/api

/v2/results

query Parameters

website

string

date_field

string

start

string

end

string

search

string

sort

string

Default: created

Responses

Paginated set of PixelResultResource

PixelResultResource[] · required

object · required

GET/v2/results

curl --request GET \
  --url http://datashopper.test/api/v2/results

Example Responses

{
  "data": [
    {
      "first_name": "first_name",
      "last_name": "last_name",
      "full_name": "full_name",
      "primary_email": "primary_email",
      "primary_phone": "primary_phone",
      "address": "address",
      "city": "city",
      "state": "state",
      "zip": "zip",
      "referral_source": "referral_source",
      "url_path": "homepage",
      "primary_device": "primary_device",
      "gender": "gender",
      "age": "age",
      "longitude": "longitude",
      "latitude": "latitude",
      "income": "income",
      "net_worth": "net_worth",
      "financial_power": "financial_power",
      "created_at": "created_at",
      "last_visit_at": "last_visit_at",
      "custom_id": "custom_id",
      "utm_source": "utm_source",
      "utm_medium": "utm_medium",
      "utm_campaign": "utm_campaign",
      "utm_term": "utm_term",
      "utm_content": "utm_content",
      "visits": "visits"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "path",
    "per_page": 0,
    "to": 1
  }
}

json

application/json

GET

http://datashopper.test/api

/v2/pixel

Responses

200

success

boolean · required

required

GET/v2/pixel

curl --request GET \
  --url http://datashopper.test/api/v2/pixel

Example Responses

{
  "success": true,
  "data": [
    {
      "id": "id",
      "name": "name",
      "slug": "slug",
      "url": "url",
      "daily_budget": "string",
      "mail_budget": "string",
      "budget_consumed": "string",
      "mail_budget_consumed": "string",
      "enable_b2b": true,
      "enable_exact_location_matching": true,
      "enable_enhanced_location_matching": true,
      "ipinfo_api_key": "ipinfo_api_key",
      "filter": "filter",
      "routes": "string",
      "zip_code_filter_type": "zip_code_filter_type",
      "zip_codes": "string",
      "state_filter_type": "state_filter_type",
      "states": "string",
      "quality_filter": "quality_filter",
      "analysis": "analysis",
      "created_at": "created_at",
      "updated_at": "updated_at",
      "campaign": {
        "utm_source": "utm_source",
        "utm_medium": "utm_medium",
        "utm_campaign": "utm_campaign",
        "utm_term": "utm_term",
        "utm_content": "utm_content"
      }
    }
  ]
}

json

application/json

POST

http://datashopper.test/api

/v2/pixel

Request Body

name

string · maxLength: 255 · required

url

string · uri · maxLength: 255 · required

filter

string | null · enum

Enum values:

include

exclude

routes

array | null · minItems: 1

Responses

success

boolean · required

WebsiteResource · required

POST/v2/pixel

curl --request POST \
  --url http://datashopper.test/api/v2/pixel \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "filter": "include",
  "routes": [
    "string"
  ]
}
'

Example Request Body

{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "filter": "include",
  "routes": [
    "string"
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "id",
    "name": "name",
    "slug": "slug",
    "url": "url",
    "daily_budget": "string",
    "mail_budget": "string",
    "budget_consumed": "string",
    "mail_budget_consumed": "string",
    "enable_b2b": true,
    "enable_exact_location_matching": true,
    "enable_enhanced_location_matching": true,
    "ipinfo_api_key": "ipinfo_api_key",
    "filter": "filter",
    "routes": "string",
    "zip_code_filter_type": "zip_code_filter_type",
    "zip_codes": "string",
    "state_filter_type": "state_filter_type",
    "states": "string",
    "quality_filter": "quality_filter",
    "analysis": "analysis",
    "created_at": "created_at",
    "updated_at": "updated_at",
    "campaign": {
      "utm_source": "utm_source",
      "utm_medium": "utm_medium",
      "utm_campaign": "utm_campaign",
      "utm_term": "utm_term",
      "utm_content": "utm_content"
    }
  }
}

json

application/json

GET

http://datashopper.test/api

/v2/pixel/{slug}

path Parameters

slug

string · required

Responses

string

Enrichment API Saved Query (ext)

Datamoon API

Pixel

GET

http://datashopper.test/api

/v2/results

query Parameters

website

string

date_field

string

start

string

end

string

search

string

sort

string

Default: created

Responses

Paginated set of PixelResultResource

PixelResultResource[] · required

object · required

GET/v2/results

curl --request GET \
  --url http://datashopper.test/api/v2/results

Example Responses

{
  "data": [
    {
      "first_name": "first_name",
      "last_name": "last_name",
      "full_name": "full_name",
      "primary_email": "primary_email",
      "primary_phone": "primary_phone",
      "address": "address",
      "city": "city",
      "state": "state",
      "zip": "zip",
      "referral_source": "referral_source",
      "url_path": "homepage",
      "primary_device": "primary_device",
      "gender": "gender",
      "age": "age",
      "longitude": "longitude",
      "latitude": "latitude",
      "income": "income",
      "net_worth": "net_worth",
      "financial_power": "financial_power",
      "created_at": "created_at",
      "last_visit_at": "last_visit_at",
      "custom_id": "custom_id",
      "utm_source": "utm_source",
      "utm_medium": "utm_medium",
      "utm_campaign": "utm_campaign",
      "utm_term": "utm_term",
      "utm_content": "utm_content",
      "visits": "visits"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "path",
    "per_page": 0,
    "to": 1
  }
}

json

application/json

GET

http://datashopper.test/api

/v2/pixel

Responses

200

success

boolean · required

required

GET/v2/pixel

curl --request GET \
  --url http://datashopper.test/api/v2/pixel

Example Responses

{
  "success": true,
  "data": [
    {
      "id": "id",
      "name": "name",
      "slug": "slug",
      "url": "url",
      "daily_budget": "string",
      "mail_budget": "string",
      "budget_consumed": "string",
      "mail_budget_consumed": "string",
      "enable_b2b": true,
      "enable_exact_location_matching": true,
      "enable_enhanced_location_matching": true,
      "ipinfo_api_key": "ipinfo_api_key",
      "filter": "filter",
      "routes": "string",
      "zip_code_filter_type": "zip_code_filter_type",
      "zip_codes": "string",
      "state_filter_type": "state_filter_type",
      "states": "string",
      "quality_filter": "quality_filter",
      "analysis": "analysis",
      "created_at": "created_at",
      "updated_at": "updated_at",
      "campaign": {
        "utm_source": "utm_source",
        "utm_medium": "utm_medium",
        "utm_campaign": "utm_campaign",
        "utm_term": "utm_term",
        "utm_content": "utm_content"
      }
    }
  ]
}

json

application/json

POST

http://datashopper.test/api

/v2/pixel

Request Body

name

string · maxLength: 255 · required

url

string · uri · maxLength: 255 · required

filter

string | null · enum

Enum values:

include

exclude

routes

array | null · minItems: 1

Responses

success

boolean · required

WebsiteResource · required

POST/v2/pixel

curl --request POST \
  --url http://datashopper.test/api/v2/pixel \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "filter": "include",
  "routes": [
    "string"
  ]
}
'

Example Request Body

{
  "name": "name",
  "url": "https://www.example.com/path/to/resource",
  "filter": "include",
  "routes": [
    "string"
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "id",
    "name": "name",
    "slug": "slug",
    "url": "url",
    "daily_budget": "string",
    "mail_budget": "string",
    "budget_consumed": "string",
    "mail_budget_consumed": "string",
    "enable_b2b": true,
    "enable_exact_location_matching": true,
    "enable_enhanced_location_matching": true,
    "ipinfo_api_key": "ipinfo_api_key",
    "filter": "filter",
    "routes": "string",
    "zip_code_filter_type": "zip_code_filter_type",
    "zip_codes": "string",
    "state_filter_type": "state_filter_type",
    "states": "string",
    "quality_filter": "quality_filter",
    "analysis": "analysis",
    "created_at": "created_at",
    "updated_at": "updated_at",
    "campaign": {
      "utm_source": "utm_source",
      "utm_medium": "utm_medium",
      "utm_campaign": "utm_campaign",
      "utm_term": "utm_term",
      "utm_content": "utm_content"
    }
  }
}

json

application/json

GET

http://datashopper.test/api

/v2/pixel/{slug}

path Parameters

slug

string · required

Responses

string

Enrichment API Saved Query (ext)