Adscore API documentation

api-schema

OPIS JSON schemas for Adscore API endpoints

Token based API access

In order to generate an API Key, please sign in to Adscore and go to https://www.adscore.com/api-keys.

Requests payloads

All payloads in POST/PATCH requests are sent as JSON.

Request examples

Account List
curl 'https://api.adscore.com/account' -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

GWoC Domain List
curl 'https://api.adscore.com/account/{account_id}/gwoc/domain' -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Report Request
curl '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 'https://api.adscore.com/account/{account_id}/transaction' -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'
Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Account Get
Account Get
GET /account/{id}
curl -X 'GET' \
  'https://api.adscore.com/account/2' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/2' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Account List
Account List
GET /account
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]'



Enter your API Key, obtained from https://www.adscore.com/api-keys
PUT Account Update
Account Update
PUT /account/{id}
curl -X 'PUT' \
  'https://api.adscore.com/account/1' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/1' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
id
integer
Account ID


Request payload
Payload parameters
Name
type
Description Constraints
name
string
User-friendly account nameMinimum length: 1
Maximum length: 255
time_zone
string (time_zone)
Default time zone for reports
fdow
string
Default first day of weekx ∈ { "monday", "sunday" }
billing_details
string
Information to be placed on invoices
external_sub_id_url
string | null
Traffic provider's SubID information page URLstring:
Maximum length: 255

meta
object
Storage used by client application
badge_info
object
Public information provided for visitors at Adscore Badge page
enabled
boolean
Whether badge should be enabled and visible
name
string
Customer's name Maximum length: 255
website
string | null
Customer's website string:
Maximum length: 255

email
string | null
Publicly available contact email string:
Maximum length: 255

phone_number
string | null
Publicly available phone number, written in international format string:
Maximum length: 64

address
string | null
Human-readable address string:
Maximum length: 255

Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Account verification completion
Account verification completion
POST /account/{id}/verify
curl -X 'POST' \
  'https://api.adscore.com/account/6/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"request_id":13,"code":7}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/6/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"request_id":13,"code":7}' \
  --compressed

Required path parameters
Name
type
Description Constraints
id
integer


Request payload
Payload parameters
Name
type
Description Constraints
request_id (required)
integer
code (required)
integer
confirmation code
Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Account verification start
Account verification start
GET /account/{id}/verify
curl -X 'GET' \
  'https://api.adscore.com/account/2/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/2/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Create API user
Create API user
POST /account/{id}/user
curl -X 'POST' \
  'https://api.adscore.com/account/20/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/20/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
id
integer


Additional parameters
Payload parameters
Name
type
Description Constraints
description
string
Maximum length: 255
ip_address
string | array
string:
Maximum length: 43

array:
Maximum length: 43
Format: ip_with_optional_netmask
Description: Allowed IP address with optional netmask (eg. 1.2.3.4 or 1.2.3.0/24)
Unique items: true
Enter your API Key, obtained from https://www.adscore.com/api-keys
DELETE Account Delete
Account Delete
DELETE /account/{account_id}/user/{id}
curl -X 'DELETE' \
  'https://api.adscore.com/account/6/user/16' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/6/user/16' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET List API users
List API users
GET /account/{id}/user
curl -X 'GET' \
  'https://api.adscore.com/account/18/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/18/user' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET GWoC Query
Resolve domain and check if it's being handled by CloudFlare and AdScore proxy
GET /account/{account_id}/gwoc/query/{domain}
curl -X 'GET' \
  'https://api.adscore.com/account/19/gwoc/query/hwkiv' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/19/gwoc/query/hwkiv' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
domain
string (hostname)


Enter your API Key, obtained from https://www.adscore.com/api-keys
POST GWoC Domain Create
Register new domain in GWoC mapping system
POST /account/{account_id}/gwoc/domain
curl -X 'POST' \
  'https://api.adscore.com/account/2/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"domain":"google.com","ip_address":"8.8.8.8","zone_id":6}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/2/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"domain":"google.com","ip_address":"8.8.8.8","zone_id":6}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer


Request payload
Payload parameters
Name
type
Description Constraints
domain (required)
string (hostname)
Domain to map from
ip_address (required)
string (ipv4)
IP address to map to
zone_id (required)
integer
Zone bound to domain
expect
integer[]
Results allowed to pass throughx ∈ { 0, 3, 6, 9 }
flags
string[]
Additional configuration flagsx ∈ { "hotlink" }
Enter your API Key, obtained from https://www.adscore.com/api-keys
DELETE GWoC Domain Delete
Delete domain from GWoC mapping system
DELETE /account/{account_id}/gwoc/domain/{id}
curl -X 'DELETE' \
  'https://api.adscore.com/account/10/gwoc/domain/18' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/10/gwoc/domain/18' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
Account ID
id
integer
GWoC Domain ID


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET GWoC Domain List
List domains registered in GWoC mapping system
GET /account/{account_id}/gwoc/domain
curl -X 'GET' \
  'https://api.adscore.com/account/6/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/6/gwoc/domain' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer

Optional query parameters
Name
type
Description Constraints
status
string
x ∈ { "active", "inactive", "pending" }
id
integer | array (integer) | string (pattern: ^(\d+)(,\d+)+$)
Domain identifiersarray:
Type: integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
PUT GWoC Domain Update
Update domain in GWoC mapping system
PUT /account/{account_id}/gwoc/domain/{id}
curl -X 'PUT' \
  'https://api.adscore.com/account/20/gwoc/domain/8' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/20/gwoc/domain/8' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer
Account ID
id
integer
GWoC Domain ID


Request payload
Payload parameters
Name
type
Description Constraints
zone_id
integer
Zone bound to domain
expect
integer[]
Results allowed to pass throughx ∈ { 0, 3, 6, 9 }
flags
string[]
Additional configuration flagsx ∈ { "hotlink" }
Enter your API Key, obtained from https://www.adscore.com/api-keys
POST GWoC Domain Verify Complete
Performs a query to origin IP address with Host header set to registered domain to check and compare proof of ownership
POST /account/{account_id}/gwoc/domain/{id}/verify
curl -X 'POST' \
  'https://api.adscore.com/account/6/gwoc/domain/1/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"secure":"true"}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/6/gwoc/domain/1/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"secure":"true"}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Request payload
Payload parameters
Name
type
Description Constraints
secure (required)
boolean
Whether to use SSL
timeout
number
Timeout for checking processMinimum: 0.1
Maximum: 10
Default: 5
Enter your API Key, obtained from https://www.adscore.com/api-keys
GET GWoC Domain Verify Start
Returns data for ownership verification of origin IP address for domain registered in GWoC mapping system
GET /account/{account_id}/gwoc/domain/{id}/verify
curl -X 'GET' \
  'https://api.adscore.com/account/18/gwoc/domain/19/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/18/gwoc/domain/19/verify' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


GET Account Badge
Account Badge public endpoint - available only if badge enabled in account settings.
GET /public/badge/{hash}
curl -X 'GET' \
  'https://api.adscore.com/public/badge/fc6801953750f6d40c911b47244c461c' curl -X 'GET' \
  'https://api.adscore.com/public/badge/fc6801953750f6d40c911b47244c461c' 

Required path parameters
Name
type
Description Constraints
hash
string


Enter your API Key, obtained from https://www.adscore.com/api-keys
DELETE Delete saved report
Delete report saved as template or schedule.
DELETE /account/{account_id}/report/{id}
curl -X 'DELETE' \
  'https://api.adscore.com/account/16/report/13' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/16/report/13' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Report get file
Get previously generated report as file in requested format
GET /account/{accountId}/report/{reportId}/{fileName}
curl -X 'GET' \
  'https://api.adscore.com/account/9/report/14/{fileName}' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/9/report/14/{fileName}' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
accountId
integer
reportId
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Saved reports List
List report saved as templates or schedules.
GET /account/{id}/report
curl -X 'GET' \
  'https://api.adscore.com/account/1/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/1/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Report Request
Request a report of traffic processed
POST /account/{id}/report
curl -X 'POST' \
  'https://api.adscore.com/account/1/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/1/report' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
id
integer
Account ID


Request payload
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.Default: false
time_zone
string
Valid IANA time zone identifier.Default: UTC
column
string[]
Additional columns to include in report.x ∈ { "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
array:
Type: string
Minimum length: 2
Maximum length: 2
Pattern: ^[A-Z][A-Z0-2]$

zone_id
array (integer) | null
array:
Type: integer

result
array (integer) | null
array:
Type: integer

sub_id
array (string) | null
array:
Type: string

time
object
Restricts report results to specified time range.
span
string
Predefined time span x ∈ { "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)
end
string
End time (https://www.php.net/manual/en/datetime.formats.php)
fdow
string
First day of week for week boundary calculations x ∈ { "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" }
group
object
Enables grouping traffic by given criteria.
zone_id
boolean
Groups by Zone ID
zone_name
boolean
Groups by Zone Name
country_code
boolean
Groups by Country Code
country_name
boolean
Groups by Country Name
result
boolean
Groups by numeric Result
result_name
boolean
Groups by Result (friendly name)
sub_id
boolean
Groups by SubID
time
string
Groups by given time span x ∈ { "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 orderarray:
Type: 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
offset
integer
The offset parameter specifies the starting point of data retrieval and is zero-indexed, meaning the first result starts at offset 0
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
name
string
Maximum length: 255
schedule
null | object | object | object
object:
frequency (required)
string
x ∈ { "daily" }
time (required)
string (time)

email (required)
Receiver email

array:
Type: string
Format: email
Maximum items: 6

format (required)
string
x ∈ { "pdf", "xlsx", "csv", "ods" }
percent
Should report be expressed in percentages instead of absolute values

boolean
Default: false


object:
frequency (required)
string
x ∈ { "weekly" }
day_of_week (required)
string
x ∈ { "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" }
time (required)
string (time)

email (required)
Receiver email

array:
Type: string
Format: email
Maximum items: 6

format (required)
string
x ∈ { "pdf", "xlsx", "csv", "ods" }
percent
Should report be expressed in percentages instead of absolute values

boolean
Default: false


object:
frequency (required)
string
x ∈ { "monthly" }
day_of_month (required)
string:
x ∈ { "last" }
integer:
Minimum: 1
Maximum: 31

time (required)
string (time)

email (required)
Receiver email

array:
Type: string
Format: email
Maximum items: 6

percent
Should report be expressed in percentages instead of absolute values

boolean
Default: false

format (required)
string
x ∈ { "pdf", "xlsx", "csv", "ods" }
Enter your API Key, obtained from https://www.adscore.com/api-keys
PUT Update saved report
Update report saved as template or schedule.
PUT /account/{account_id}/report/{id}
curl -X 'PUT' \
  'https://api.adscore.com/account/20/report/7' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/20/report/7' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Request payload
Payload parameters
Name
type
Description Constraints
time_zone
string
Valid IANA time zone identifier.Default: UTC
column
string[]
Additional columns to include in report.x ∈ { "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
array:
Type: string
Minimum length: 2
Maximum length: 2
Pattern: ^[A-Z][A-Z0-2]$

zone_id
array (integer) | null
array:
Type: integer

result
array (integer) | null
array:
Type: integer

sub_id
array (string) | null
array:
Type: string

time
object
Restricts report results to specified time range.
span
string
Predefined time span x ∈ { "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)
end
string
End time (https://www.php.net/manual/en/datetime.formats.php)
fdow
string
First day of week for week boundary calculations x ∈ { "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" }
group
object
Enables grouping traffic by given criteria.
zone_id
boolean
Groups by Zone ID
zone_name
boolean
Groups by Zone Name
country_code
boolean
Groups by Country Code
country_name
boolean
Groups by Country Name
result
boolean
Groups by numeric Result
result_name
boolean
Groups by Result (friendly name)
sub_id
boolean
Groups by SubID
time
string
Groups by given time span x ∈ { "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 orderarray:
Type: 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
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
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
name
string
Minimum length: 1
Maximum length: 255
schedule
null | object | object | object
object:
frequency
string
x ∈ { "daily" }
time
string (time)

email
Receiver email

array:
Type: string
Format: email
Maximum items: 6

format
string
x ∈ { "pdf", "xlsx", "csv", "ods" }
percent
Should report be expressed in percentages instead of absolute values

boolean
Default: false


object:
frequency
string
x ∈ { "weekly" }
day_of_week
string
x ∈ { "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" }
time
string (time)

email
Receiver email

array:
Type: string
Format: email
Maximum items: 6

format
string
x ∈ { "pdf", "xlsx", "csv", "ods" }
percent
Should report be expressed in percentages instead of absolute values

boolean
Default: false


object:
frequency
string
x ∈ { "monthly" }
day_of_month
string:
x ∈ { "last" }
integer:
Minimum: 1
Maximum: 31

time
string (time)

email
Receiver email

array:
Type: string
Format: email
Maximum items: 6

format
string
x ∈ { "pdf", "xlsx", "csv", "ods" }
percent
Should report be expressed in percentages instead of absolute values

boolean
Default: false

Enter your API Key, obtained from https://www.adscore.com/api-keys
PATCH Session Alter
Update session status or extend validity time
PATCH /session
curl -X 'PATCH' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'PATCH' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'



Request payload
Payload parameters
Name
type
Description Constraints
email
string (email)
password
string
Minimum length: 1
expiry
integer | null
Validity of session in seconds
authenticator
object
Authenticator parameters
token
string
Authenticator output, for example one-time password Minimum length: 1
type
string
Type of authenticator used Minimum length: 1
Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Session Create
Acquire interactive user session
POST /session
curl -X 'POST' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"email":"[email protected]","password":"5ljui"}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"email":"[email protected]","password":"5ljui"}' \
  --compressed



Request payload
Payload parameters
Name
type
Description Constraints
email (required)
string (email)
password (required)
string
Minimum length: 1
expiry
integer | null
Validity of session in seconds
domain
hostname | ipv4
Domain authorized to perform requests
Enter your API Key, obtained from https://www.adscore.com/api-keys
DELETE Session Delete
Logout all sessions
DELETE /session
curl -X 'DELETE' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'



Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Session Read
Check session status
GET /session
curl -X 'GET' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/session' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'



Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Session Token
Acquire timed token
POST /session/token
curl -X 'POST' \
  'https://api.adscore.com/session/token' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"password":"o858b"}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/session/token' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"password":"o858b"}' \
  --compressed



Request payload
Payload parameters
Name
type
Description Constraints
password (required)
string
Minimum length: 1
Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Zone Custom Fields
List of Zone Custom Fields
GET /list/zone_custom_fields
curl -X 'GET' \
  'https://api.adscore.com/list/zone_custom_fields' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/list/zone_custom_fields' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'



Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Transaction List
List transactions with optional filtering by their status
GET /account/{account_id}/transaction
curl -X 'GET' \
  'https://api.adscore.com/account/18/transaction' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/18/transaction' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
Account ID

Optional query parameters
Name
type
Description Constraints
start
string (date-time) or string (date)
end
string (date-time) or string (date)
offset
integer
Minimum: 0
Default: 0
limit
integer
Minimum (exclusive): 0
Default: 100
id
integer | array (integer) | string (pattern: ^(\d+)(,\d+)+$)
Transaction identifiersarray:
Type: integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Transaction Read
Get transaction details
GET /account/{account_id}/transaction/{id}
curl -X 'GET' \
  'https://api.adscore.com/account/7/transaction/16' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/7/transaction/16' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Transaction Invoice Read
Generate PDF invoice for single transaction
GET /account/{account_id}/transaction/{transaction_id}/invoice
curl -X 'GET' \
  'https://api.adscore.com/account/20/transaction/15/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/20/transaction/15/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
transaction_id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Transaction Invoice Read Many
Generate PDF invoice for multiple transactions
POST /account/{account_id}/transaction/invoice
curl -X 'POST' \
  'https://api.adscore.com/account/8/transaction/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"transaction_id":18}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/8/transaction/invoice' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"transaction_id":18}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer


Request payload
Payload parameters
Name
type
Description Constraints
transaction_id (required)
integer | array (integer)
Transaction ID or array of IDs
Enter your API Key, obtained from https://www.adscore.com/api-keys
GET User Read
Get user details
GET /user
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]'



Enter your API Key, obtained from https://www.adscore.com/api-keys
GET User Reset Complete
Validates attached token and performs password reset
GET /user/reset/{id}/{token}
curl -X 'GET' \
  'https://api.adscore.com/user/reset/16/xgmif' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user/reset/16/xgmif' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
id
integer
User ID
token
string
Token used to authorize requestMinimum length: 1


Request payload
Payload parameters
Name
type
Description Constraints
password (required)
string
New password to setMinimum length: 1
Enter your API Key, obtained from https://www.adscore.com/api-keys
GET User Reset Entry
Validates attached token to allow performing password reset
GET /user/reset/{id}/{token}
curl -X 'GET' \
  'https://api.adscore.com/user/reset/15/mr3d3' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/user/reset/15/mr3d3' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
id
integer
User ID
token
string
Token used to authorize requestMinimum length: 1


Enter your API Key, obtained from https://www.adscore.com/api-keys
POST User Reset Request
Request to reset user e-mail address
POST /user/reset/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-raw '{"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-raw '{"email":"[email protected]"}' \
  --compressed



Request payload
Payload parameters
Name
type
Description Constraints
email (required)
string (email)
Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Zone Code Generation
Generate code for Zone
POST /account/{account_id}/zone/{id}/code
curl -X 'POST' \
  'https://api.adscore.com/account/20/zone/3/code' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/20/zone/3/code' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Request payload
Payload parameters
Name
type
Description Constraints
type (required)
string
Typex ∈ { "link_iframe", "link_redirect", "link_redirect_conditional", "js_api_conditional", "js_proxy_conditional", "cloudflare_worker", "js_tag", "js_api" }
referrer
string
When set to no-referrer, the redirection to the target URL will not carry referrer header (ie. blank referrer).Default: origin
x ∈ { "origin", "no-referrer" }
sub_id
string | number
Subzone IDstring:
Maximum length: 256

number:
Minimum: 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.Minimum: 0
Maximum: 1
Default: 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.Minimum: 0
Maximum: 1
Default: 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.Minimum: 0
Maximum: 1
Default: 0
compatibility
boolean
Compatibility mode enforces usage of ? symbol instead of #. Use when standard generated URL is invalid for your needs.Default: false

Conditional payload parameters
Name
type
Description Constraints Available when
data (required)
string (url_with_parameters)
Redirection URL, can contain parameters enclosed in one of formats: $[name] [name] ${name} {name} type ∈ { link_iframe, link_redirect }
data (required)
object
expect (required)
Expected judge result. Any of: ["ok", "junk", "proxy", "bot"]

array (judge_result_names)

pass (required)
Url when passed judge, can contain custom parameters enclosed in one of formats: $[name] [name] ${name} {name}

string (url_with_parameters)

fail
Url when failed judge, can contain parameters enclosed in one of formats: $[name] [name] ${name} {name}

string (url_with_parameters)

type ∈ { link_redirect_conditional }
data (required)
object
expect (required)
Expected judge result. Any of: ["ok", "junk", "proxy", "bot"]

array (judge_result_names)

type ∈ { js_api_conditional, js_proxy_conditional, cloudflare_worker }
compliant (required)
boolean
Compliant with RFC 3986 Default: false
type ∈ { link_iframe, link_redirect, link_redirect_conditional }
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) Default: preload
x ∈ { "preload", "none", "preconnect" }
type ∈ { link_redirect }

Enter your API Key, obtained from https://www.adscore.com/api-keys
POST Zone Create
Create new Zone
POST /account/{id}/zone
curl -X 'POST' \
  'https://api.adscore.com/account/3/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"name":"fglfh"}' \
  --compressedcurl -X 'POST' \
  'https://api.adscore.com/account/3/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{"name":"fglfh"}' \
  --compressed

Required path parameters
Name
type
Description Constraints
id
integer
Account ID


Zone data
Payload parameters
Name
type
Description Constraints
name (required)
string
Name of the ZoneMinimum length: 1
request_auth
string | null
string:
x ∈ { "hash_sha256", "sign_sha256" }
response_auth
string
Default: hash_sha256
x ∈ { "hash_sha256", "sign_sha256", "v5_0200H", "v5_0200S", "v5_0201H", "v5_0201S" }
request_referrer
string | array | null
string:
Maximum length: 255

array:
Type: string
Maximum length: 255
Format: url_with_wildcard

external_sub_id_url
string | null
Traffic provider's SubID information page URLstring:
Maximum length: 255

traffic_options
object
enable_subid_anomaly_detection
boolean
Default: true
allow_good_bots
boolean
Default: false
allow_google_scanners
boolean
Default: false
enable_anti_piracy_compliance
boolean
Default: false
allow_lite_processing
boolean
Default: false
iframe_handling
string
Default: auto
x ∈ { "auto", "deny" }
subid_source
string
Default: parameter
x ∈ { "parameter", "location_domain", "referrer_domain", "location_param_utm_source", "location_param_utm_campaign", "location_param_utm_medium" }
enable_compliance_intelligence
boolean
Default: true
enable_referrer_blacklisting
boolean
Default: true
mobile_request_as_desktop_traffic
boolean
Default: true
Enter your API Key, obtained from https://www.adscore.com/api-keys
DELETE Zone Delete
Remove Zone
DELETE /account/{account_id}/zone/{id}
curl -X 'DELETE' \
  'https://api.adscore.com/account/8/zone/20' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'DELETE' \
  'https://api.adscore.com/account/8/zone/20' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Zone List
List zones with optional filtering by their status
GET /account/{account_id}/zone
curl -X 'GET' \
  'https://api.adscore.com/account/5/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/5/zone' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer

Optional query parameters
Name
type
Description Constraints
status
string
If used, shows only zones in specified statusx ∈ { "active", "inactive" }
id
integer | array (integer) | string (pattern: ^(\d+)(,\d+)+$)
Zone identifiersarray:
Type: integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Zone LTAM
Get zone Long Term Anomaly data
GET /account/{account_id}/zone/{id}/ltam
curl -X 'GET' \
  'https://api.adscore.com/account/19/zone/9/ltam' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/19/zone/9/ltam' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer


Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Zone Read
Get zone details
GET /account/{account_id}/zone/{id}
curl -X 'GET' \
  'https://api.adscore.com/account/19/zone/4' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/19/zone/4' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer

Optional query parameters
Name
type
Description Constraints
token
string
Timed token to reveal zone keysMinimum length: 1

Enter your API Key, obtained from https://www.adscore.com/api-keys
GET Zone Stats
Get zone statistics
GET /account/{account_id}/zone/{id}/stats
curl -X 'GET' \
  'https://api.adscore.com/account/3/zone/17/stats' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'curl -X 'GET' \
  'https://api.adscore.com/account/3/zone/17/stats' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]'

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer

Optional query parameters
Name
type
Description Constraints
subId
string | number
Subzone IDstring:
Maximum length: 256

number:
Minimum: 0
hardwareConcurrency
string | number
Number of proccessorsstring:
x ∈ { "Unknown" }
number:
Minimum (exclusive): 0
GPUModel
string
GPU ModelMaximum length: 128
webrtc
integer
WebRTC ONMinimum: 0
Maximum: 1
webgl
string
WebGLx ∈ { "webgl", "webgl2", "webgl-experimental", "none" }
referrer
string | number
Referrer namestring:
Maximum length: 256

judge
string
Referrer judgmentx ∈ { "Unknown", "ok", "junk", "proxy", "bot" }
incognito
string | integer
Incognito mode ONstring:
x ∈ { "Unknown" }
integer:
Minimum: 0
Maximum: 1
language
string
LanguageMaximum length: 16
deviceMemory
string | number
Device memorystring:
x ∈ { "Unknown" }
number:
Minimum: 0
ip_geo_country
string
CountryMaximum length: 16
ip_geo_city
string
CityMaximum length: 128
ip_geo_region
string
Most specific subdivision regionMaximum length: 128
ip_geo_timezone
string
TimezoneMaximum length: 64
ip_connectionType
string
Internet connection typeMaximum length: 16
ip_isp_ispName
string
Internet Service Provider nameMaximum length: 64
userAgent_os:name
string
Operating System nameMaximum length: 128
userAgent_form_factor:name
string
Device typeMaximum length: 128
userAgent_device:name
string
Device nameMaximum length: 128
userAgent_browser:name
string
Browser name and versionMaximum length: 128
devices
string
Peripheral devicesMaximum length: 32

Enter your API Key, obtained from https://www.adscore.com/api-keys
PUT Zone Update
Update Zone
PUT /account/{account_id}/zone/{id}
curl -X 'PUT' \
  'https://api.adscore.com/account/1/zone/19' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressedcurl -X 'PUT' \
  'https://api.adscore.com/account/1/zone/19' \
  -H 'Authorization: Basic [PUT_YOUR_API_KEY_HERE]' \
  -H 'content-type: application/json' \
  --data-raw '{}' \
  --compressed

Required path parameters
Name
type
Description Constraints
account_id
integer
id
integer

Optional query parameters
Name
type
Description Constraints
token
string
2FA token, currently disabled (does no effect)Minimum length: 1

Zone data
Payload parameters
Name
type
Description Constraints
id
integer
name
string
Name of the ZoneMinimum length: 1
request_auth
string | null
string:
x ∈ { "hash_sha256", "sign_sha256" }
response_auth
string
x ∈ { "hash_sha256", "sign_sha256", "v5_0200H", "v5_0200S", "v5_0201H", "v5_0201S" }
request_referrer
string | array | null
string:
Maximum length: 255

array:
Type: string
Maximum length: 255
Format: url_with_wildcard

external_sub_id_url
string | null
Traffic provider's SubID information page URLstring:
Maximum length: 255

traffic_options
object
enable_subid_anomaly_detection
boolean
Default: true
allow_good_bots
boolean
Default: false
allow_google_scanners
boolean
Default: false
enable_anti_piracy_compliance
boolean
Default: false
allow_lite_processing
boolean
Default: false
iframe_handling
string
Default: auto
x ∈ { "auto", "deny" }
subid_source
string
Default: parameter
x ∈ { "parameter", "location_domain", "referrer_domain", "location_param_utm_source", "location_param_utm_campaign", "location_param_utm_medium" }
enable_compliance_intelligence
boolean
Default: true
enable_referrer_blacklisting
boolean
Default: true
mobile_request_as_desktop_traffic
boolean
Default: 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