Get started

This is Adscore REST API documentation, prepared for users who wish to interact with Adscore programmatically. In order to get started using this API, you first need to register at https://www.adscore.com/register.
Note: this API is meant to interact with features available in Adscore's Dashboard, e.g. retrieving report analyses, managing transactions or creating Zones. If you'd like to use Adscore's JavaScript API, please see here.

Authentication

Using the Adscore REST API requires authentication, except for Public endpoints. There are two ways to authenticate yourself with Adscore's REST API:

  1. Using API keys
    This is the most common method. In order to generate an API Key, please sign in to Adscore and go to https://www.adscore.com/api-keys. Once you generate an API key, you need to attach it to your Adscore REST API requests as an
    Authorization
    header with a value of
    Basic [PUT_YOUR_API_KEY_HERE]
    .
  2. Using an interactive session
    This method is less common and may be used in case you’re for example developing a mobile app for some end user. It doesn't use API keys and lets you sign in as any user using the Session endpoints. Please follow these steps if you'd like to use the interactive session authentication:
    1. Acquire an interactive user session using the Session Create endpoint.
    2. Use the key acquired in Step I to authenticate your requests. You need to attach it to your Adscore REST API requests as a
      Key
      header.
    3. Use the Session Alter when you need to extend the session or use the Session Create endpoint again if you need to create a new session. You'll get a new key every time you use one of these endpoints.

Requests payloads

All payloads in POST/PATCH requests are sent as JSON. Required properties of each request are marked, all other properties are optional.

Request examples

Account List 
curl -X 'GET' \
    'https://api.adscore.com/account' \
    -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
GWoC Domain List 
curl -X 'GET' \
    'https://api.adscore.com/account/{account_id}/gwoc/domain' -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
Report Request 
curl -X 'GET' \
    'https://api.adscore.com/account/{account_id}/report' -H 'content-type: application/json' -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' --data-raw '{"group":{"time":"day"},"order":[{"time":"desc"}],"column":["result_0_count","result_3_count","result_6_count","result_9_count","result_0_perc","result_3_perc","result_6_perc","result_9_perc","cost"],"time":{"start":"2022-01-01 00:00:00","end":"2022-02-02 23:59:59"},"sub_id":[],"zone_id":[],"country_code":[],"volatile":true,"time_zone":"Asia/Dubai","limit":1001}'
Transaction List 
curl -X 'GET' \
    'https://api.adscore.com/account/{account_id}/transaction' -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Account Get

Last update (UTC): Wed, 12 Oct 2022 20:21:07 GMT Go to raw schemaExternal link indicator 
GET/account/{id}
Required path parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Account List

Last update (UTC): Wed, 12 Oct 2022 20:21:07 GMT Go to raw schemaExternal link indicator 
GET/account
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Account Update

Last update (UTC): Wed, 24 May 2023 13:05:49 GMT Go to raw schemaExternal link indicator 
PUT/account/{id}
Required path parameters
Name
Type		 Description Constraints
id
integer 		Account ID
Example value:
100
Payload parameters
Name
Type		 Description Constraints
name
string 		User-friendly account nameMinimum length: 1
Maximum length: 255
Example value:
abcde
time_zone
string [time_zone] 		Default time zone for reportsFormat: time_zone
Example value:
UTC
fdow
string 		Default first day of week
Allowed values:
monday
sunday
billing_details
string 		Information to be placed on invoices
Example value:
abcde
external_sub_id_url
string | null 		Traffic provider's SubID information page URLMaximum length: 255
Example value:
https://google.com/{param}
meta
object 		Storage used by client application
Example value:
{}
badge_info
object 		Public information provided for visitors at Adscore Badge page
Example value:
{ "enabled": true, "name": "abcde", "website": "https://google.com", "email": "[email protected]", "phone_number": "+48500000000", "address": "abcde" }
enabled
boolean		 Whether badge should be enabled and visible
Allowed values:
true
false
name
string		 Customer's name Maximum length: 255
Example value:
abcde
website
string		 Customer's website Maximum length: 255
Example value:
https://google.com
email
string		 Publicly available contact email Maximum length: 255
Example value:
[email protected]
phone_number
string		 Publicly available phone number, written in international format Maximum length: 64
Example value:
+48500000000
address
string		 Human-readable address Maximum length: 255
Example value:
abcde
Example request:
curl -X 'PUT' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'PUT' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "name": "abcde",
 "time_zone": "UTC",
 "fdow": "monday",
 "billing_details": "abcde",
 "external_sub_id_url": "https://google.com/{param}",
 "meta": {},
 "badge_info": {
  "enabled": true,
  "name": "abcde",
  "website": "https://google.com",
  "email": "[email protected]",
  "phone_number": "+48500000000",
  "address": "abcde"
 }
}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "name": "abcde",
 "time_zone": "UTC",
 "fdow": "monday",
 "billing_details": "abcde",
 "external_sub_id_url": "https://google.com/{param}",
 "meta": {},
 "badge_info": {
  "enabled": true,
  "name": "abcde",
  "website": "https://google.com",
  "email": "[email protected]",
  "phone_number": "+48500000000",
  "address": "abcde"
 }
}' \
  --compressed

Account verification completion

Last update (UTC): Wed, 12 Oct 2022 20:21:07 GMT Go to raw schemaExternal link indicator 
POST/account/{id}/verify
Required path parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
request_id required
integer
Example value:
100
code required
integer 		confirmation code
Example value:
100
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "request_id": 100,
 "code": 100
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "request_id": 100,
 "code": 100
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "request_id": 100,
 "code": 100
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "request_id": 100,
 "code": 100
}' \
  --compressed

Account verification start

Last update (UTC): Wed, 12 Oct 2022 20:21:07 GMT Go to raw schemaExternal link indicator 
GET/account/{id}/verify
Required path parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Create API user

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
POST/account/{id}/user
Required path parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
description
string 		Maximum length: 255
Example value:
abcde
ip_address
string | array 		Allowed IP address with optional netmask (eg. 1.2.3.4 or 1.2.3.0/24)Maximum length: 43
Format: ip_with_optional_netmask
Unique items: true
Example value:
["8.8.8.8"]
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "description": "abcde",
 "ip_address": "8.8.8.8"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "description": "abcde",
 "ip_address": "8.8.8.8"
}' \
  --compressed

Account Delete

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
DELETE/account/{account_id}/user/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Example request:
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/user/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/user/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/user/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/user/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

List API users

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
GET/account/{id}/user
Required path parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Resolve domain and check if it's being handled by CloudFlare and AdScore proxy

Last update (UTC): Fri, 17 Mar 2023 14:25:29 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/gwoc/query/{domain}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
domain
string [hostname] 		Format: hostname
Example value:
google.com
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/query/google.com' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/query/google.com' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/query/google.com' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/query/google.com' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Register new domain in GWoC mapping system

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
POST/account/{account_id}/gwoc/domain
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
domain required
string [hostname] 		Domain to map fromFormat: hostname
Example value:
google.com
ip_address required
string [ipv4] 		IP address to map toFormat: ipv4
Example value:
8.8.8.8
zone_id required
integer 		Zone bound to domain
Example value:
100
expect
integer[] 		Results allowed to pass through
Allowed values:
0
3
6
9
flags
string[] 		Additional configuration flags
Allowed values:
hotlink
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "domain": "google.com",
 "ip_address": "8.8.8.8",
 "zone_id": 100
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "domain": "google.com",
 "ip_address": "8.8.8.8",
 "zone_id": 100
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "domain": "google.com",
 "ip_address": "8.8.8.8",
 "zone_id": 100,
 "expect": [
  0
 ],
 "flags": [
  "hotlink"
 ]
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "domain": "google.com",
 "ip_address": "8.8.8.8",
 "zone_id": 100,
 "expect": [
  0
 ],
 "flags": [
  "hotlink"
 ]
}' \
  --compressed

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Delete domain from GWoC mapping system

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
DELETE/account/{account_id}/gwoc/domain/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer 		Account ID
Example value:
100
id
integer 		GWoC Domain ID
Example value:
100
Example request:
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

List domains registered in GWoC mapping system

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/gwoc/domain
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
Optional query parameters
Name
Type		 Description Constraints
status
string
Allowed values:
active
inactive
pending
id
integer | array [integer] | string 		Domain identifiers
Example value for integer:
100
Pattern for string:
^(\d+)(,\d+)+$
Example value for string:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain?status=active&id=100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain?status=active&id=100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Update domain in GWoC mapping system

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
PUT/account/{account_id}/gwoc/domain/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer 		Account ID
Example value:
100
id
integer 		GWoC Domain ID
Example value:
100
Payload parameters
Name
Type		 Description Constraints
zone_id
integer 		Zone bound to domain
Example value:
100
expect
integer[] 		Results allowed to pass through
Allowed values:
0
3
6
9
flags
string[] 		Additional configuration flags
Allowed values:
hotlink
Example request:
curl -X 'PUT' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'PUT' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "zone_id": 100,
 "expect": [
  0
 ],
 "flags": [
  "hotlink"
 ]
}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100/gwoc/domain/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "zone_id": 100,
 "expect": [
  0
 ],
 "flags": [
  "hotlink"
 ]
}' \
  --compressed

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Performs a query to origin IP address with Host header set to registered domain to check and compare proof of ownership

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
POST/account/{account_id}/gwoc/domain/{id}/verify
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
secure required
boolean 		Whether to use SSL
Allowed values:
true
false
timeout
number 		Timeout for checking processMinimum value:
0.1

Maximum value:
10

Default value:
5
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "secure": true
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "secure": true
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "secure": true,
 "timeout": 5
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "secure": true,
 "timeout": 5
}' \
  --compressed

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Returns data for ownership verification of origin IP address for domain registered in GWoC mapping system

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/gwoc/domain/{id}/verify
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/gwoc/domain/100/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Account Badge public endpoint - available only if badge enabled in account settings

Last update (UTC): Fri, 19 May 2023 13:23:26 GMT Go to raw schemaExternal link indicator 
GET/public/badge/{hash}
Required path parameters
Name
Type		 Description Constraints
hash
string
Example value:
fc6801953750f6d40c911b47244c461c
Example request:
curl -X 'GET' \
  'https://api.adscore.com/public/badge/fc6801953750f6d40c911b47244c461c' curl -X 'GET' \
  'https://api.adscore.com/public/badge/fc6801953750f6d40c911b47244c461c' 
curl -X 'GET' \
  'https://api.adscore.com/public/badge/fc6801953750f6d40c911b47244c461c' curl -X 'GET' \
  'https://api.adscore.com/public/badge/fc6801953750f6d40c911b47244c461c'

Delete report saved as template or schedule

Last update (UTC): Thu, 18 May 2023 15:33:04 GMT Go to raw schemaExternal link indicator 
DELETE/account/{account_id}/report/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Example request:
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Get previously generated report as file in requested format

Last update (UTC): Mon, 21 Aug 2023 20:41:49 GMT Go to raw schemaExternal link indicator 
GET/account/{accountId}/report/{reportId}/{fileName}
Required path parameters
Name
Type		 Description Constraints
accountId
integer
Example value:
100
reportId
integer
Example value:
100
Optional path parameters
Name
Type		 Description Constraints
fileName
string
Example value:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/report/100/{fileName}' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/report/100/{fileName}' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/report/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/report/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

List report saved as templates or schedules

Last update (UTC): Thu, 18 May 2023 15:33:04 GMT Go to raw schemaExternal link indicator 
GET/account/{id}/report
Required path parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Request a report of traffic processed

Last update (UTC): Thu, 18 May 2023 15:33:04 GMT Go to raw schemaExternal link indicator 
POST/account/{id}/report
Required path parameters
Name
Type		 Description Constraints
id
integer 		Account ID
Example value:
100
Payload parameters
Name
Type		 Description Constraints
volatile
boolean 		Determines, whether report results are returned in response for this request (TRUE), or stored for separate download. Defaults to FALSE.
Allowed values:
true
false
Default value:
false
time_zone
string 		Valid IANA time zone identifier.
Default value:
UTC
column
string[] 		Additional columns to include in report.
Allowed values:
cost
result_0_count
result_0_cost
result_0_perc
result_3_count
result_3_cost
result_3_perc
result_6_count
result_6_cost
result_6_perc
result_9_count
result_9_cost
result_9_perc
country_code
array [string] | null 		Restricts report results to specified countries.Minimum length: 2
Maximum length: 2
Pattern:
^[A-Z][A-Z0-2]$

Example value:
["US"]
zone_id
array [integer] | null 		Restricts report results to specified zones.
Example value:
[100]
result
array [integer] | null 		Restricts report results to specified result codes.
Example value:
[0]
sub_id
array [string] | null 		Restricts report results to specified SubIDs.
Example value:
["abcde"]
time
object 		Restricts report results to specified time range.
Example value:
{ "start": "2025-01-29 00:20:29", "end": "2025-02-05 00:20:29" }
span
string		 Predefined time span
Allowed values:
total
today
yesterday
this_week
last_week
this_month
last_month
this_year
last_year
start
string		 Start time (https://www.php.net/manual/en/datetime.formats.php)
Example value:
abcde
end
string		 End time (https://www.php.net/manual/en/datetime.formats.php)
Example value:
abcde
fdow
string		 First day of week for week boundary calculations
Allowed values:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
group
object 		Enables grouping traffic by given criteria.
Example value:
{ "zone_id": true, "zone_name": true, "country_code": true, "country_name": true, "result": true, "result_name": true, "sub_id": true, "time": "hour" }
zone_id
boolean		 Groups by Zone ID
Allowed values:
true
false
zone_name
boolean		 Groups by Zone Name
Allowed values:
true
false
country_code
boolean		 Groups by Country Code
Allowed values:
true
false
country_name
boolean		 Groups by Country Name
Allowed values:
true
false
result
boolean		 Groups by numeric Result
Allowed values:
true
false
result_name
boolean		 Groups by Result (friendly name)
Allowed values:
true
false
sub_id
boolean		 Groups by SubID
Allowed values:
true
false
time
string		 Groups by given time span
Allowed values:
hour
day
week
month
year
order
object | array 		The order parameter should be an object (or array of objects) with a single property representing the column name and its corresponding value as either “ASC” or “DESC”, indicating the desired sorting order
Example value for object:
{}
limit
integer 		Maximum number of records, should be set to one higher than desired limit to ensure the requested amount of records are returned
Example value:
100
offset
integer 		The offset parameter specifies the starting point of data retrieval and is zero-indexed, meaning the first result starts at offset 0
Example value:
100
minimum
object 		The minimum parameter should be an object with a single property representing the column name and its corresponding value as the minimum value for that column
Example value:
{}
name
string 		Maximum length: 255
Example value:
abcde
schedule
null | object 		Schedule settings
frequency required
string
Allowed values:
daily
weekly
monthly
time required
string		 Format: time
Example value:
{ "start": "2025-01-29 00:20:29", "end": "2025-02-05 00:20:29" }
email required
array [string]		 Receiver email Format: email
Maximum items: 6
Example value:
["[email protected]"]
format required
string
Allowed values:
pdf
xlsx
csv
ods
percent
boolean		 Should report be expressed in percentages instead of absolute values
Allowed values:
true
false
Default value:
false
day_of_week required
string		 This parameter can be specified only if frequency is
weekly
Allowed values:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
day_of_month required
string | integer		 This parameter can be specified only if frequency is
monthly
Allowed values for string:
last
Allowed values for integer:
1-31
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "volatile": false,
 "time_zone": "UTC",
 "column": [
  "cost"
 ],
 "country_code": [
  "US"
 ],
 "zone_id": [
  100
 ],
 "result": [
  0
 ],
 "sub_id": [
  "abcde"
 ],
 "time": {
  "start": "2025-01-29 00:20:29",
  "end": "2025-02-05 00:20:29"
 },
 "group": {
  "zone_id": true,
  "zone_name": true,
  "country_code": true,
  "country_name": true,
  "result": true,
  "result_name": true,
  "sub_id": true,
  "time": "hour"
 },
 "order": {},
 "limit": 100,
 "offset": 100,
 "minimum": {},
 "name": "abcde",
 "schedule": {
  "frequency": "daily",
  "time": "16:30:00",
  "email": "[email protected]",
  "format": "pdf",
  "percent": true
 }
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "volatile": false,
 "time_zone": "UTC",
 "column": [
  "cost"
 ],
 "country_code": [
  "US"
 ],
 "zone_id": [
  100
 ],
 "result": [
  0
 ],
 "sub_id": [
  "abcde"
 ],
 "time": {
  "start": "2025-01-29 00:20:29",
  "end": "2025-02-05 00:20:29"
 },
 "group": {
  "zone_id": true,
  "zone_name": true,
  "country_code": true,
  "country_name": true,
  "result": true,
  "result_name": true,
  "sub_id": true,
  "time": "hour"
 },
 "order": {},
 "limit": 100,
 "offset": 100,
 "minimum": {},
 "name": "abcde",
 "schedule": {
  "frequency": "daily",
  "time": "16:30:00",
  "email": "[email protected]",
  "format": "pdf",
  "percent": true
 }
}' \
  --compressed

Update report saved as template or schedule

Last update (UTC): Thu, 18 May 2023 15:33:04 GMT Go to raw schemaExternal link indicator 
PUT/account/{account_id}/report/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
time_zone
string 		Valid IANA time zone identifier.
Default value:
UTC
column
string[] 		Additional columns to include in report.
Allowed values:
cost
result_0_count
result_0_cost
result_0_perc
result_3_count
result_3_cost
result_3_perc
result_6_count
result_6_cost
result_6_perc
result_9_count
result_9_cost
result_9_perc
country_code
array [string] | null 		Restricts report results to specified countries.Minimum length: 2
Maximum length: 2
Pattern:
^[A-Z][A-Z0-2]$

Example value:
["US"]
zone_id
array [integer] | null 		Restricts report results to specified zones.
Example value:
[100]
result
array [integer] | null 		Restricts report results to specified result codes.
Example value:
[0]
sub_id
array [string] | null 		Restricts report results to specified SubIDs.
Example value:
["abcde"]
time
object 		Restricts report results to specified time range.
Example value:
{ "start": "2025-01-29 00:20:29", "end": "2025-02-05 00:20:29" }
span
string		 Predefined time span
Allowed values:
total
today
yesterday
this_week
last_week
this_month
last_month
this_year
last_year
start
string		 Start time (https://www.php.net/manual/en/datetime.formats.php)
Example value:
abcde
end
string		 End time (https://www.php.net/manual/en/datetime.formats.php)
Example value:
abcde
fdow
string		 First day of week for week boundary calculations
Allowed values:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
group
object 		Enables grouping traffic by given criteria.
Example value:
{ "zone_id": true, "zone_name": true, "country_code": true, "country_name": true, "result": true, "result_name": true, "sub_id": true, "time": "hour" }
zone_id
boolean		 Groups by Zone ID
Allowed values:
true
false
zone_name
boolean		 Groups by Zone Name
Allowed values:
true
false
country_code
boolean		 Groups by Country Code
Allowed values:
true
false
country_name
boolean		 Groups by Country Name
Allowed values:
true
false
result
boolean		 Groups by numeric Result
Allowed values:
true
false
result_name
boolean		 Groups by Result (friendly name)
Allowed values:
true
false
sub_id
boolean		 Groups by SubID
Allowed values:
true
false
time
string		 Groups by given time span
Allowed values:
hour
day
week
month
year
order
object | array | null 		The order parameter should be an object (or array of objects) with a single property representing the column name and its corresponding value as either “ASC” or “DESC”, indicating the desired sorting order
Example value for object:
{}
limit
integer | null 		Maximum number of records, should be set to one higher than desired limit to ensure the requested amount of records are returned
Example value:
100
offset
integer | null 		The offset parameter specifies the starting point of data retrieval and is zero-indexed, meaning the first result starts at offset 0
Example value:
100
minimum
integer | null 		The minimum parameter should be an object with a single property representing the column name and its corresponding value as the minimum value for that column
Example value:
100
name
string 		Minimum length: 1
Maximum length: 255
Example value:
abcde
schedule
null | object 		Schedule settings
frequency
string
Allowed values:
daily
weekly
monthly
time
string		 Format: time
Example value:
{ "start": "2025-01-29 00:20:29", "end": "2025-02-05 00:20:29" }
email
array [string]		 Receiver email Format: email
Maximum items: 6
Example value:
["[email protected]"]
format
string
Allowed values:
pdf
xlsx
csv
ods
percent
boolean		 Should report be expressed in percentages instead of absolute values
Allowed values:
true
false
Default value:
false
day_of_week
string		 This parameter can be specified only if frequency is
weekly
Allowed values:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
day_of_month
string | integer		 This parameter can be specified only if frequency is
monthly
Allowed values for string:
last
Allowed values for integer:
1-31
Example request:
curl -X 'PUT' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'PUT' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "time_zone": "UTC",
 "column": [
  "cost"
 ],
 "country_code": [
  "US"
 ],
 "zone_id": [
  100
 ],
 "result": [
  0
 ],
 "sub_id": [
  "abcde"
 ],
 "time": {
  "start": "2025-01-29 00:20:29",
  "end": "2025-02-05 00:20:29"
 },
 "group": {
  "zone_id": true,
  "zone_name": true,
  "country_code": true,
  "country_name": true,
  "result": true,
  "result_name": true,
  "sub_id": true,
  "time": "hour"
 },
 "order": {},
 "limit": 100,
 "offset": 100,
 "minimum": 100,
 "name": "abcde",
 "schedule": {
  "frequency": "daily",
  "time": "16:30:00",
  "email": "[email protected]",
  "format": "pdf",
  "percent": true
 }
}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100/report/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "time_zone": "UTC",
 "column": [
  "cost"
 ],
 "country_code": [
  "US"
 ],
 "zone_id": [
  100
 ],
 "result": [
  0
 ],
 "sub_id": [
  "abcde"
 ],
 "time": {
  "start": "2025-01-29 00:20:29",
  "end": "2025-02-05 00:20:29"
 },
 "group": {
  "zone_id": true,
  "zone_name": true,
  "country_code": true,
  "country_name": true,
  "result": true,
  "result_name": true,
  "sub_id": true,
  "time": "hour"
 },
 "order": {},
 "limit": 100,
 "offset": 100,
 "minimum": 100,
 "name": "abcde",
 "schedule": {
  "frequency": "daily",
  "time": "16:30:00",
  "email": "[email protected]",
  "format": "pdf",
  "percent": true
 }
}' \
  --compressed

WarningThis endpoint is not meant for regular use. It should only be used, when you access the Adscore's REST API using an interactive session method.

Update session status or extend validity time

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
PATCH/session
Payload parameters
Name
Type		 Description Constraints
email
string [email] 		Format: email
Example value:
[email protected]
password
string 		Minimum length: 1
Example value:
abcde
expiry
integer | null 		Validity of session in seconds
Allowed values for integer:
60-1209600
authenticator
object 		Authenticator parameters
Example value:
{ "token": "abcde", "type": "abcde" }
token
string		 Authenticator output, for example one-time password Minimum length: 1
Example value:
abcde
type
string		 Type of authenticator used Minimum length: 1
Example value:
abcde
Example request:
curl -X 'PATCH' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'PATCH' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'PATCH' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]",
 "password": "abcde",
 "expiry": 100,
 "authenticator": {
  "token": "abcde",
  "type": "abcde"
 }
}' \
  --compressedcurl -X 'PATCH' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]",
 "password": "abcde",
 "expiry": 100,
 "authenticator": {
  "token": "abcde",
  "type": "abcde"
 }
}' \
  --compressed

WarningThis endpoint is not meant for regular use. It should only be used, when you access the Adscore's REST API using an interactive session method.

Acquire interactive user session

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
POST/session
Payload parameters
Name
Type		 Description Constraints
email required
string [email] 		Format: email
Example value:
[email protected]
password required
string 		Minimum length: 1
Example value:
abcde
expiry
integer | null 		Validity of session in seconds
Allowed values for integer:
60-1209600
domain
string 		Domain authorized to perform requestsFormat: hostname or ipv4
Example value for string (hostname):
google.com
Example value for string (ipv4):
8.8.8.8
Example request:
curl -X 'POST' \
  'https://api.adscore.com/session'  \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]",
 "password": "abcde"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/session'  \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]",
 "password": "abcde"
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/session'  \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]",
 "password": "abcde",
 "expiry": 100,
 "domain": "google.com"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/session'  \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]",
 "password": "abcde",
 "expiry": 100,
 "domain": "google.com"
}' \
  --compressed

WarningThis endpoint is not meant for regular use. It should only be used, when you access the Adscore's REST API using an interactive session method.

Logout all sessions

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
DELETE/session
Example request:
curl -X 'DELETE' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'
curl -X 'DELETE' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'

WarningThis endpoint is not meant for regular use. It should only be used, when you access the Adscore's REST API using an interactive session method.

Check session status

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
GET/session
Example request:
curl -X 'GET' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/session' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]'

Acquire timed token

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
POST/session/token
Payload parameters
Name
Type		 Description Constraints
password required
string 		Minimum length: 1
Example value:
abcde
Example request:
curl -X 'POST' \
  'https://api.adscore.com/session/token' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "password": "abcde"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/session/token' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "password": "abcde"
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/session/token' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "password": "abcde"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/session/token' \
  -H 'Key: [PUT_YOUR_SESSION_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "password": "abcde"
}' \
  --compressed

List of data fields available to embed into V5 signatures

Last update (UTC): Tue, 25 Jun 2024 12:43:34 GMT Go to raw schemaExternal link indicator 
GET/list/zone_fields
Example request:
curl -X 'GET' \
  'https://api.adscore.com/list/zone_fields' curl -X 'GET' \
  'https://api.adscore.com/list/zone_fields' 
curl -X 'GET' \
  'https://api.adscore.com/list/zone_fields' curl -X 'GET' \
  'https://api.adscore.com/list/zone_fields'

List transactions with optional filtering by their status

Last update (UTC): Fri, 17 Mar 2023 14:25:29 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/transaction
Required path parameters
Name
Type		 Description Constraints
account_id
integer 		Account ID
Example value:
100
Optional query parameters
Name
Type		 Description Constraints
start
string 		Format: date-time or date
Example value for string (date-time):
2024-01-01T10:05:08
Example value for string (date):
2024-01-01
end
string 		Format: date-time or date
Example value for string (date-time):
2024-01-01T10:05:08
Example value for string (date):
2024-01-01
offset
integer 		Minimum value:
0

Default value:
0
limit
integer 		Minimum value (exclusive):
0

Default value:
100
id
integer | array [integer] | string 		Transaction identifiers
Example value for integer:
100
Pattern for string:
^(\d+)(,\d+)+$
Example value for string:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction?start=2024-01-01T10:05:08&end=2024-01-01T10:05:08&offset=0&limit=100&id=100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction?start=2024-01-01T10:05:08&end=2024-01-01T10:05:08&offset=0&limit=100&id=100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Get transaction details

Last update (UTC): Fri, 17 Mar 2023 14:25:29 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/transaction/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Generate PDF invoice for single transaction

Last update (UTC): Fri, 17 Mar 2023 14:25:29 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/transaction/{transaction_id}/invoice
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
transaction_id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/transaction/100/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Generate PDF invoice for multiple transactions

Last update (UTC): Fri, 17 Mar 2023 14:25:29 GMT Go to raw schemaExternal link indicator 
POST/account/{account_id}/transaction/invoice
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
transaction_id required
integer | array (integer) 		Transaction ID or array of IDs
Example value for integer:
100
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/transaction/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "transaction_id": 100
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/transaction/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "transaction_id": 100
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/transaction/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "transaction_id": 100
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/transaction/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "transaction_id": 100
}' \
  --compressed

Get user details

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
GET/user
Example request:
curl -X 'GET' \
  'https://api.adscore.com/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Validates attached token and performs password reset

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
GET/user/reset/{id}/{token}
Required path parameters
Name
Type		 Description Constraints
id
integer 		User ID
Example value:
100
token
string 		Token used to authorize requestMinimum length: 1
Example value:
abcde
Payload parameters
Name
Type		 Description Constraints
password required
string 		New password to setMinimum length: 1
Example value:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Validates attached token to allow performing password reset

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
GET/user/reset/{id}/{token}
Required path parameters
Name
Type		 Description Constraints
id
integer 		User ID
Example value:
100
token
string 		Token used to authorize requestMinimum length: 1
Example value:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user/reset/100/abcde' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Request to reset user e-mail address

Last update (UTC): Mon, 20 Mar 2023 14:10:23 GMT Go to raw schemaExternal link indicator 
POST/user/reset/request
Payload parameters
Name
Type		 Description Constraints
email required
string [email] 		Format: email
Example value:
[email protected]
Example request:
curl -X 'POST' \
  'https://api.adscore.com/user/reset/request' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/user/reset/request' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]"
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/user/reset/request' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/user/reset/request' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "email": "[email protected]"
}' \
  --compressed

Generate code for Zone

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
POST/account/{account_id}/zone/{id}/code
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Payload parameters
Name
Type		 Description Constraints
referrer
string 		When set to no-referrer, the redirection to the target URL will not carry referrer header (ie. blank referrer).
Allowed values:
origin
no-referrer
Default value:
origin
sub_id
string | number 		Subzone IDMaximum length for string: 256
Example value for string:
abcde
Minimum value for number:
0
ipv6_priority
integer 		By default, Adscore works on IPv4 with additional IPv6 gatherer. This means that Adscore will always know the visitor IPv4 address and in most cases, if visitor has it, IPv6 address. In case you use Adscore Signature to verify traffic in your backend and your website uses IPv6, there is a possibility that our system will see only the IPv4 address (and use it for the signature) and your system will see only the IPv6 address. In such a case, the signature verification will fail. To resolve this problem, you can set ipv6_priority to 1 which will force Adscore to work on IPv6 as the primary visitor address.
Allowed values:
0-1
Default value:
0
lite
integer 		Some Adscore client-side modules which test visitor’s hardware, mainly GPU, tend to be time and resource consuming. On modern devices they usually take a couple hundred milliseconds, however in some cases this can take up to a few seconds (for example virtual machines). Setting the lite parameter to 1 will disable these modules, which will lower the detection quality (in certain, rare cases), but will reduce the client-side processing time by around 70% on average. Please make sure to set Allow Adscore Lite Processing in Zone Settings to Yes. Failing to do so will result in all traffic to be detected as bot.
Allowed values:
0-1
Default value:
0
async_callback
integer 		By default, Adscore Javascript module will first gather all necessary data, then send it to our backend and then wait for the backend response to be able to provide you Adscore Signature through the callback. In some cases however, the signature is not necessary so waiting for the backend response is not needed either. In such a case, setting async_callback to 1 will make our code send data to our backend using navigator.sendBeacon, allowing us to speed up client-side processing. Your callback will be executed immediately after data is queued to be sent to our backend, but obviously will not have any values in the result object. However, doing so will also make it not possible for our system to cache verification results. This means that all subsequent hits by the same visitor will require full analysis to be repeated each time, which will not be optimal from a performance point of view. For this reason, the async_callback option should only be used on unique traffic, where one visitor is verified only once.
Allowed values:
0-1
Default value:
0
compatibility
boolean 		Compatibility mode enforces usage of ? symbol instead of #. Use when standard generated URL is invalid for your needs.
Allowed values:
true
false
Default value:
false
type required
string 		Type
Allowed values:
link_iframe
link_redirect
link_redirect_conditional
js_api_conditional
js_proxy_conditional
cloudflare_worker
js_tag
js_api
Payload parameters dependent on the "type" parameter
Payload parameters for:
{type:'link_iframe'}
Example:
{type:link_iframe, data:'https://adscore.com', compliant:false}
compliant required
boolean 		Compliant with RFC 3986
Allowed values:
true
false
Default value:
false
data required
string 		Redirection URL, can contain parameters enclosed in one of formats: $[name] [name] ${name} {name}Format: url_with_parameters
Example value:
https://google.com/{param}
Payload parameters for:
{type:'link_redirect'}
Example:
{type:link_redirect, data:'https://adscore.com', compliant:false, prefetch_mode:preload}
compliant required
boolean 		Compliant with RFC 3986
Allowed values:
true
false
Default value:
false
prefetch_mode
string 		preload - (maximal performance, might cause partial double counting by trackers) none - (lower performance, won't cause double counting by trackers) preconnect - (partial performance benefits, won't cause double counting by trackers)
Allowed values:
preload
none
preconnect
Default value:
preload
data required
string 		Redirection URL, can contain parameters enclosed in one of formats: $[name] [name] ${name} {name}Format: url_with_parameters
Example value:
https://google.com/{param}
Payload parameters for:
{type:'link_redirect_conditional'}
Example:
{type:link_redirect_conditional, data:{expect:ok, pass:'https://adscore.com', fail:'https://abc.com'}, compliant:false}
compliant required
boolean 		Compliant with RFC 3986
Allowed values:
true
false
Default value:
false
data required
object
Example value:
{}
expect
judge_result_names[]		 Expected judge result. Any of: ["ok", "junk", "proxy", "bot"] Format: judge_result_names
pass
string		 Url when passed judge, can contain custom parameters enclosed in one of formats: $[name] [name] ${name} {name} Format: url_with_parameters
Example value:
https://google.com/{param}
fail
string		 Url when failed judge, can contain parameters enclosed in one of formats: $[name] [name] ${name} {name} Format: url_with_parameters
Example value:
https://google.com/{param}
Payload parameters for:
{type:'js_api_conditional'}
{type:'js_proxy_conditional'}
{type:'cloudflare_worker'}
Example:
{type:js_api_conditional, data:{expect:ok}}
{type:js_proxy_conditional, data:{expect:ok}}
{type:cloudflare_worker, data:{expect:ok}}
data required
object
Example value:
{}
expect
judge_result_names[]		 Expected judge result. Any of: ["ok", "junk", "proxy", "bot"] Format: judge_result_names
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/zone/100/code' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "compliant": false,
 "type": "link_iframe",
 "data": "https://google.com/{param}"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/zone/100/code' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "compliant": false,
 "type": "link_iframe",
 "data": "https://google.com/{param}"
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/zone/100/code' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "type": "link_iframe",
 "referrer": "origin",
 "compliant": false,
 "sub_id": "abcde",
 "ipv6_priority": 0,
 "lite": 0,
 "async_callback": 0,
 "data": "https://google.com/{param}",
 "compatibility": false
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/zone/100/code' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "type": "link_iframe",
 "referrer": "origin",
 "compliant": false,
 "sub_id": "abcde",
 "ipv6_priority": 0,
 "lite": 0,
 "async_callback": 0,
 "data": "https://google.com/{param}",
 "compatibility": false
}' \
  --compressed

Create new Zone

Last update (UTC): Sun, 10 Mar 2024 23:17:46 GMT Go to raw schemaExternal link indicator 
POST/account/{id}/zone
Required path parameters
Name
Type		 Description Constraints
id
integer 		Account ID
Example value:
100
Payload parameters
Name
Type		 Description Constraints
name required
string 		Name of the ZoneMinimum length: 1
Example value:
abcde
request_auth
string | null
Allowed values:
hash_sha256
sign_sha256
response_auth
string
Allowed values:
hash_sha256
sign_sha256
v5_0200H
v5_0200S
v5_0200I
v5_0200M
v5_0200J
v5_0201H
v5_0201S
v5_0201I
v5_0201M
v5_0201J
v5_0101H
v5_0101S
v5_0101I
v5_0101M
v5_0101J
Default value:
hash_sha256
request_referrer
string | array | null 		Maximum length: 255
Format: url_with_wildcard
Example value:
["https://google.com/"]
external_sub_id_url
string | null 		Traffic provider's SubID information page URLMaximum length: 255
Example value:
https://google.com/{param}
traffic_options
object
Example value:
{ "enable_subid_anomaly_detection": true, "allow_good_bots": true, "allow_google_scanners": true, "enable_anti_piracy_compliance": true, "allow_lite_processing": true, "iframe_handling": "auto", "subid_source": "parameter", "enable_compliance_intelligence": true, "enable_referrer_blacklisting": true, "mobile_request_as_desktop_traffic": true }
enable_subid_anomaly_detection
boolean
Allowed values:
true
false
Default value:
true
allow_good_bots
boolean
Allowed values:
true
false
Default value:
false
allow_google_scanners
boolean
Allowed values:
true
false
Default value:
false
enable_anti_piracy_compliance
boolean
Allowed values:
true
false
Default value:
false
allow_lite_processing
boolean
Allowed values:
true
false
Default value:
false
iframe_handling
string
Allowed values:
auto
deny
Default value:
auto
subid_source
string
Allowed values:
parameter
location_domain
referrer_domain
location_param_utm_source
location_param_utm_campaign
location_param_utm_medium
Default value:
parameter
enable_compliance_intelligence
boolean
Allowed values:
true
false
Default value:
true
enable_referrer_blacklisting
boolean
Allowed values:
true
false
Default value:
true
mobile_request_as_desktop_traffic
boolean
Allowed values:
true
false
Default value:
true
custom_fields
array | null 		List of keys of custom fields that are present in SignatureV5. Full current list of available keys can be obtained from /list/zone_custom_fields
Example request:
curl -X 'POST' \
  'https://api.adscore.com/account/100/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "name": "abcde"
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "name": "abcde"
}' \
  --compressed
curl -X 'POST' \
  'https://api.adscore.com/account/100/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "name": "abcde",
 "request_auth": "hash_sha256",
 "response_auth": "hash_sha256",
 "request_referrer": "https://google.com/",
 "external_sub_id_url": "https://google.com/{param}",
 "traffic_options": {
  "enable_subid_anomaly_detection": true,
  "allow_good_bots": true,
  "allow_google_scanners": true,
  "enable_anti_piracy_compliance": true,
  "allow_lite_processing": true,
  "iframe_handling": "auto",
  "subid_source": "parameter",
  "enable_compliance_intelligence": true,
  "enable_referrer_blacklisting": true,
  "mobile_request_as_desktop_traffic": true
 },
 "custom_fields": null
}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/100/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{
 "name": "abcde",
 "request_auth": "hash_sha256",
 "response_auth": "hash_sha256",
 "request_referrer": "https://google.com/",
 "external_sub_id_url": "https://google.com/{param}",
 "traffic_options": {
  "enable_subid_anomaly_detection": true,
  "allow_good_bots": true,
  "allow_google_scanners": true,
  "enable_anti_piracy_compliance": true,
  "allow_lite_processing": true,
  "iframe_handling": "auto",
  "subid_source": "parameter",
  "enable_compliance_intelligence": true,
  "enable_referrer_blacklisting": true,
  "mobile_request_as_desktop_traffic": true
 },
 "custom_fields": null
}' \
  --compressed

Remove Zone

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
DELETE/account/{account_id}/zone/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Example request:
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'DELETE' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

List zones with optional filtering by their status

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/zone
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
Optional query parameters
Name
Type		 Description Constraints
status
string 		If used, shows only zones in specified status
Allowed values:
active
inactive
id
integer | array [integer] | string 		Zone identifiers
Example value for integer:
100
Pattern for string:
^(\d+)(,\d+)+$
Example value for string:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone?status=active&id=100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone?status=active&id=100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

WarningThis feature is not available in the Adscore dashboard yet. You can only access it using the API.

Get zone Long Term Anomaly data

Last update (UTC): Thu, 06 Apr 2023 11:42:19 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/zone/{id}/ltam
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/ltam' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/ltam' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/ltam' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/ltam' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Get zone details

Last update (UTC): Tue, 07 May 2024 21:34:07 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/zone/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Optional query parameters
Name
Type		 Description Constraints
token
string 		Timed token to reveal zone keys (required only for interactive sessions)Minimum length: 1
Example value:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100?token=abcde' curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100?token=abcde'

Get zone statistics

Last update (UTC): Sun, 23 Jul 2023 12:59:21 GMT Go to raw schemaExternal link indicator 
GET/account/{account_id}/zone/{id}/stats
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Optional query parameters
Name
Type		 Description Constraints
subId
string | number 		Subzone IDMaximum length for string: 256
Example value for string:
abcde
Minimum value for number:
0
hardwareConcurrency
string | number 		Number of proccessors
Allowed values for string:
Unknown
Minimum value (exclusive) for number:
0
GPUModel
string 		GPU ModelMaximum length: 128
Example value:
abcde
webrtc
integer 		WebRTC ON
Allowed values:
0-1
webgl
string 		WebGL
Allowed values:
webgl
webgl2
webgl-experimental
none
referrer
string | number 		Referrer nameMaximum length for string: 256
Example value for string:
abcde
judge
string 		Referrer judgment
Allowed values:
Unknown
ok
junk
proxy
bot
incognito
string | integer 		Incognito mode ON
Allowed values for string:
Unknown
Allowed values for integer:
0-1
language
string 		LanguageMaximum length: 16
Example value:
abcde
deviceMemory
string | number 		Device memory
Allowed values for string:
Unknown
Minimum value for number:
0
ip_geo_country
string 		CountryMaximum length: 16
Example value:
abcde
ip_geo_city
string 		CityMaximum length: 128
Example value:
abcde
ip_geo_region
string 		Most specific subdivision regionMaximum length: 128
Example value:
abcde
ip_geo_timezone
string 		TimezoneMaximum length: 64
Example value:
abcde
ip_connectionType
string 		Internet connection typeMaximum length: 16
Example value:
abcde
ip_isp_ispName
string 		Internet Service Provider nameMaximum length: 64
Example value:
abcde
userAgent_os:name
string 		Operating System nameMaximum length: 128
Example value:
abcde
userAgent_form_factor:name
string 		Device typeMaximum length: 128
Example value:
abcde
userAgent_device:name
string 		Device nameMaximum length: 128
Example value:
abcde
userAgent_browser:name
string 		Browser name and versionMaximum length: 128
Example value:
abcde
devices
string 		Peripheral devicesMaximum length: 32
Example value:
abcde
Example request:
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/stats' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/stats' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/stats?webgl=webgl' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/100/zone/100/stats?webgl=webgl' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Update Zone

Last update (UTC): Sun, 10 Mar 2024 23:17:46 GMT Go to raw schemaExternal link indicator 
PUT/account/{account_id}/zone/{id}
Required path parameters
Name
Type		 Description Constraints
account_id
integer
Example value:
100
id
integer
Example value:
100
Optional query parameters
Name
Type		 Description Constraints
token
string 		2FA token, currently disabled (does no effect)Minimum length: 1
Example value:
abcde
Payload parameters
Name
Type		 Description Constraints
id
integer
Example value:
100
name
string 		Name of the ZoneMinimum length: 1
Example value:
abcde
request_auth
string | null
Allowed values:
hash_sha256
sign_sha256
response_auth
string
Allowed values:
hash_sha256
sign_sha256
v5_0200H
v5_0200S
v5_0200I
v5_0200M
v5_0200J
v5_0201H
v5_0201S
v5_0201I
v5_0201M
v5_0201J
v5_0101H
v5_0101S
v5_0101I
v5_0101M
v5_0101J
request_referrer
string | array | null 		Maximum length: 255
Format: url_with_wildcard
Example value:
["https://google.com/"]
external_sub_id_url
string | null 		Traffic provider's SubID information page URLMaximum length: 255
Example value:
https://google.com/{param}
traffic_options
object
Example value:
{ "enable_subid_anomaly_detection": true, "allow_good_bots": true, "allow_google_scanners": true, "enable_anti_piracy_compliance": true, "allow_lite_processing": true, "iframe_handling": "auto", "subid_source": "parameter", "enable_compliance_intelligence": true, "enable_referrer_blacklisting": true, "mobile_request_as_desktop_traffic": true }
enable_subid_anomaly_detection
boolean
Allowed values:
true
false
Default value:
true
allow_good_bots
boolean
Allowed values:
true
false
Default value:
false
allow_google_scanners
boolean
Allowed values:
true
false
Default value:
false
enable_anti_piracy_compliance
boolean
Allowed values:
true
false
Default value:
false
allow_lite_processing
boolean
Allowed values:
true
false
Default value:
false
iframe_handling
string
Allowed values:
auto
deny
Default value:
auto
subid_source
string
Allowed values:
parameter
location_domain
referrer_domain
location_param_utm_source
location_param_utm_campaign
location_param_utm_medium
Default value:
parameter
enable_compliance_intelligence
boolean
Allowed values:
true
false
Default value:
true
enable_referrer_blacklisting
boolean
Allowed values:
true
false
Default value:
true
mobile_request_as_desktop_traffic
boolean
Allowed values:
true
false
Default value:
true
custom_fields
array | null 		List of keys of custom fields that are present in SignatureV5. Full current list of available keys can be obtained from /list/zone_custom_fields
Example request:
curl -X 'PUT' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100/zone/100' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data '{}' \
  --compressed
curl -X 'PUT' \
  'https://api.adscore.com/account/100/zone/100?token=abcde'  \
  -H 'content-type: application/json' \
  --data '{
 "id": 100,
 "name": "abcde",
 "request_auth": "hash_sha256",
 "response_auth": "hash_sha256",
 "request_referrer": "https://google.com/",
 "external_sub_id_url": "https://google.com/{param}",
 "traffic_options": {
  "enable_subid_anomaly_detection": true,
  "allow_good_bots": true,
  "allow_google_scanners": true,
  "enable_anti_piracy_compliance": true,
  "allow_lite_processing": true,
  "iframe_handling": "auto",
  "subid_source": "parameter",
  "enable_compliance_intelligence": true,
  "enable_referrer_blacklisting": true,
  "mobile_request_as_desktop_traffic": true
 },
 "custom_fields": null
}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/100/zone/100?token=abcde'  \
  -H 'content-type: application/json' \
  --data '{
 "id": 100,
 "name": "abcde",
 "request_auth": "hash_sha256",
 "response_auth": "hash_sha256",
 "request_referrer": "https://google.com/",
 "external_sub_id_url": "https://google.com/{param}",
 "traffic_options": {
  "enable_subid_anomaly_detection": true,
  "allow_good_bots": true,
  "allow_google_scanners": true,
  "enable_anti_piracy_compliance": true,
  "allow_lite_processing": true,
  "iframe_handling": "auto",
  "subid_source": "parameter",
  "enable_compliance_intelligence": true,
  "enable_referrer_blacklisting": true,
  "mobile_request_as_desktop_traffic": true
 },
 "custom_fields": null
}' \
  --compressed