Hitsteps Whitelabel API Documentation (1.0)

Hitsteps: sales@hitsteps.com URL: https://hitsteps.com

This documentation provide guideline on how to interact with Hitsteps whitelabel backend.

Initialization

Receive whitelabel token code

This API receive email and password of main account where whitelabel is purchased and return whitelabel token of the account.

Request Body schema: multipart/form-data

username	string
password	string

Responses

Response Schema: application/json

error	integer
main_account	string
token	string

Response samples

200

Content type

application/json

{"error": 0,
"main_account": "1234",
"token": "b91267234abc2354b2324c134ad3454f2c"
}

Get whitelabel detail

Given Token and main account, return whitelabel detail

Request Body schema: multipart/form-data

token	string
main_account	string

Responses

Response Schema: application/json

	object
error	integer

Response samples

200

Content type

application/json

{"0": {"whitelabel_id": "1",
"whitelabel_brand": "Hitsteps",
"whitelabel_url": "hitsteps.com"
},
"1": {"whitelabel_id": "2",
"whitelabel_brand": "Hitsteps Whitelabel",
"whitelabel_url": "whitelabel.hitsteps.com"
},
"error": 0
}

Get list of whitelabel brand accounts

Get list of accounts under a whitelabel brand

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer

Responses

Response Schema: application/json

object

Response samples

200

Content type

application/json

{"0": {"user_account_id": "12",
"user_account_email": "account@example.com",
"user_nick": "Jack",
"user_account_statusmode": null,
"user_trial_status": "1",
"user_license_code": "0",
"user_license_expiry": "1007514389"
},
"1": {"user_account_id": "13",
"user_account_email": "customer@example.com",
"user_nick": "John",
"user_account_statusmode": null,
"user_trial_status": "0",
"user_license_code": "3",
"user_license_expiry": "1230021058"
},
"error": 0
}

Account

Get account ID from email

Given email, return account ID

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_email	string

Responses

Response Schema: application/json

error	integer
user_account_id	string

Response samples

200

Content type

application/json

{"error": 0,
"user_account_id": "18"
}

Get account detail

Given accout ID, return account detail.

Request Body schema: application/x-www-form-urlencoded

token	string
whitelabel_id	integer
user_account_id	integer

Responses

Response Schema: application/json

error	integer
user_account_id	string
user_account_email	string
user_timezone	string
user_country	string
user_language	string
user_nickname	string
user_account_statusmode	string
user_license_code	string
user_trial_status	string
user_license_expiry	string

Response samples

200

Content type

application/json

{"error": 0,
"user_account_id": "22",
"user_account_email": "sales@hitsteps.com",
"user_timezone": "8",
"user_country": "my",
"user_language": "en",
"user_nickname": "Hitsteps",
"user_account_statusmode": "1",
"user_license_code": "1",
"user_trial_status": "0",
"user_license_expiry": "1586041271"
}

Get account ID from API key

Given API key, return account ID

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
tracking_api_key	string

Responses

Response Schema: application/json

user_account_id	integer
APIKey	string
error	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_account_id": 3,
"APIKey": "b21345654321b4233232b"
}

Get account and website detail given website URL

Given Website Full URL, return account and website detail.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
website_url	string

Responses

Response Schema: application/json

error	integer
user_email	string
user_account_id	string
website_name	string
website_url	string
website_id	string
APIKey	string
submission_date	string
total_pageviews	integer
total_visitors	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_email": "sales@hitsteps.com",
"user_account_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"website_id": "18",
"APIKey": "34567645332b42354224a4242343544c345b",
"submission_date": "1089804558",
"total_pageviews": 1000,
"total_visitors": 200
}

Get account and website detail given website URL

Given Website URL, return account and website detail that match website domain.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
website_url	string

Responses

Response Schema: application/json

error	integer
user_email	string
user_account_id	string
website_name	string
website_url	string
website_id	string
APIKey	string
submission_date	string
total_pageviews	integer
total_visitors	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_email": "sales@hitsteps.com",
"user_account_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"website_id": "18",
"APIKey": "34567645332b42354224a4242343544c345b",
"submission_date": "1089804558",
"total_pageviews": 1000,
"total_visitors": 200
}

Get website detail from API key

Given API Key, return website detail associated with the API key.

Request Body schema: multipart/form-data

token	string
whitelabel_id	string
tracking_api_key	string

Responses

Response Schema: application/json

error	integer
user_email	string
user_account_id	string
website_name	string
website_url	string
website_id	string
APIKey	string
submission_date	string
total_pageviews	integer
total_visitors	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_email": "sales@hitsteps.com",
"user_account_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"website_id": "18",
"APIKey": "34567645332b42354224a4242343544c345b",
"submission_date": "1089804558",
"total_pageviews": 1000,
"total_visitors": 200
}

Get list of whitelabel brand accounts

Get list of accounts under a whitelabel brand

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer

Responses

Response Schema: application/json

object

Response samples

200

Content type

application/json

{"0": {"user_account_id": "12",
"user_account_email": "account@example.com",
"user_nick": "Jack",
"user_account_statusmode": null,
"user_trial_status": "1",
"user_license_code": "0",
"user_license_expiry": "1007514389"
},
"1": {"user_account_id": "13",
"user_account_email": "customer@example.com",
"user_nick": "John",
"user_account_statusmode": null,
"user_trial_status": "0",
"user_license_code": "3",
"user_license_expiry": "1230021058"
},
"error": 0
}

Change account email address

Update a customer account email address

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer
new_email	string

Responses

Response Schema: application/json

error	integer
oldemail	string
newemail	string
msg	string

Response samples

200

Content type

application/json

{"error": 0,
"oldemail": "old@example.com",
"newemail": "new@example.com",
"msg": "Email changed from old to new."
}

Change account password

Given account id and new password, update account's password.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer
new_password	string

Responses

Response Schema: application/json

error

integer

Response samples

200

Content type

application/json

{"error": 0
}

Register a new account

Create a new account under whitelabel brand.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
email	string
password	string
nickname	string
language	string

Responses

Response Schema: application/json

error	integer
user_account_id	integer
msg	string

Response samples

200

Content type

application/json

{"error": 0,
"user_account_id": 213,
"msg": "Account created."
}

Get a direct link to specified service

Return direct link to specified services in whitelabel domain:

dashboard
livemap
onlineusers
recentpageviews
popularpages
topentrypages
topexitpages
downloads
downloadactivity
chat
users
departments
shortcuts
chatsettings
overview
recentvisitors
loyalvisitors
uniquevisitors
topcountry
visitormap
averagetraffic
excludeip
exportcsv
browseros
resolution
language
cookie
cpu
timezone
recentreferral
topreferral
socialmedia
blockreferral
exitlink
exitlinkactivity
searchengine
keywordanalysis
recentkeywords
keywordtrends
labels
newlabel
goals
newgoal
campaigns
newcampaign
sitesetting
accountsetting
listmysites

Request Body schema: multipart/form-data

whitelabel_id	integer
token	string
website_id	integer
reportname	string

Responses

Response Schema: application/json

error	integer
autologin_url	string
simple_url	string

Response samples

200

Content type

application/json

{"error": 0,
"autologin_url": "http://whitelabel.brand/login.php?code=b123432433&service=dashboard",
"simple_url": "http://whitelabel.brand/stats/34234/dashboard"
}

Website

Get account and website detail given website URL

Given Website Full URL, return account and website detail.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
website_url	string

Responses

Response Schema: application/json

error	integer
user_email	string
user_account_id	string
website_name	string
website_url	string
website_id	string
APIKey	string
submission_date	string
total_pageviews	integer
total_visitors	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_email": "sales@hitsteps.com",
"user_account_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"website_id": "18",
"APIKey": "34567645332b42354224a4242343544c345b",
"submission_date": "1089804558",
"total_pageviews": 1000,
"total_visitors": 200
}

Get account and website detail given website URL

Given Website URL, return account and website detail that match website domain.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
website_url	string

Responses

Response Schema: application/json

error	integer
user_email	string
user_account_id	string
website_name	string
website_url	string
website_id	string
APIKey	string
submission_date	string
total_pageviews	integer
total_visitors	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_email": "sales@hitsteps.com",
"user_account_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"website_id": "18",
"APIKey": "34567645332b42354224a4242343544c345b",
"submission_date": "1089804558",
"total_pageviews": 1000,
"total_visitors": 200
}

Get website detail from API key

Given API Key, return website detail associated with the API key.

Request Body schema: multipart/form-data

token	string
whitelabel_id	string
tracking_api_key	string

Responses

Response Schema: application/json

error	integer
user_email	string
user_account_id	string
website_name	string
website_url	string
website_id	string
APIKey	string
submission_date	string
total_pageviews	integer
total_visitors	integer

Response samples

200

Content type

application/json

{"error": 0,
"user_email": "sales@hitsteps.com",
"user_account_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"website_id": "18",
"APIKey": "34567645332b42354224a4242343544c345b",
"submission_date": "1089804558",
"total_pageviews": 1000,
"total_visitors": 200
}

Get list of account websites

Given account id, return list of websites that are being tracked in an account

Responses

Response Schema: application/json

	object
	object
error	integer

Response samples

200

Content type

application/json

{"0": {"website_id": "33",
"website_name": "Hitsteps",
"website_url": "hitsteps.com",
"APIKey": "bb3b12b3b5b6b532b436b",
"submission_date": "1084804558",
"total_pageviews": 1000,
"total_visitors": 200
},
"1": {"website_id": "34",
"website_name": "Hitsteps Whitelabel",
"website_url": "whitelabel.hitsteps.com",
"APIKey": "b2b4536b5423b452b45b3",
"submission_date": "1001796422",
"total_pageviews": 900,
"total_visitors": 100
},
"error": 0
}

Add a site to track under an account

Add a new site to track under account.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer
site_name	string
site_url	string

Responses

Response Schema: application/json

error	integer
msg	string
APIKey	string
user_account_id	integer
website_id	integer
site_url	string

Response samples

200

Content type

application/json

{"error": 0,
"msg": "Website added.",
"APIKey": "b123b3432b5b23232ab324",
"user_account_id": 32,
"website_id": 34,
"site_url": "hitsteps.com"
}

Add a site to track under an account (Full URL)

Add a new site to track under account given Full URL.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer
site_name	string
site_url	string

Responses

Response Schema: application/json

error	integer
msg	string
APIKey	string
user_account_id	integer
website_id	integer
site_url	string

Response samples

200

Content type

application/json

{"error": 0,
"msg": "Website added.",
"APIKey": "b123b3432b5b23232ab324",
"user_account_id": 32,
"website_id": 34,
"site_url": "hitsteps.com"
}

Billing

Request free trial

Request free 14 days trial activation for an account.

Request Body schema: multipart/form-data

token	string
whitelabel_id	string
user_account_id	string

Responses

Response Schema: application/json

error	integer
expire	integer
msg	string

Response samples

200

Content type

application/json

{"error": 0,
"expire": 123436234,
"msg": "Trial activated"
}

Request free plan activation

Free plan provide limited functionality. An account can be converted to free account to avoid dashboard asking user to pay for basic analytics features.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer

Responses

Response Schema: application/json

error	integer
msg	string

Response samples

200

Content type

application/json

{"error": 0,
"msg": "Free account activated"
}

Purchase a license for an account

Allow purchasing a license for an account under your whitelabel, and receive invoice to pay our share at end of the month.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer
plan	integer
duration	integer months. for example 1, 3, 6, 9 or 12.

Responses

Response Schema: application/json

error	integer
msg	string
license_converted	integer
license_convert_old_plan	integer
license_convert_new_plan	integer
license_convert_old_price	integer
license_convert_new_price	number
license_convert_old_price_days	integer
license_convert_new_price_days	integer
license_convert_total_days	integer
hitsteps_share	number
license_plan_id	integer
license_plan_name	string
license_plan_months	integer
license_expiry	integer
license_expiry_processed	string

Response samples

200

Content type

application/json

{"error": 0,
"msg": "License activated",
"license_converted": 0,
"license_convert_old_plan": 0,
"license_convert_new_plan": 3,
"license_convert_old_price": 0,
"license_convert_new_price": 9.99,
"license_convert_old_price_days": 2,
"license_convert_new_price_days": 28,
"license_convert_total_days": 30,
"hitsteps_share": 6.99,
"license_plan_id": 3,
"license_plan_name": "Pro",
"license_plan_months": 12,
"license_expiry": 1234623540,
"license_expiry_processed": "2016-09-16"
}

Convert an existing license to other license

Upgrade or downgrade an license without charging a fee by converting remaining days of a license to new license by pro rata calculation.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
user_account_id	integer
newplan	integer

Responses

Response Schema: application/json

error	integer
msg	string
license_converted	integer
license_convert_old_plan	integer
license_convert_new_plan	integer
license_convert_old_price	integer
license_convert_new_price	number
license_convert_old_price_days	integer
license_convert_new_price_days	integer
license_convert_total_days	integer
hitsteps_share	integer
license_plan_id	integer
license_plan_name	string
license_plan_months	integer
license_expiry	integer
license_expiry_processed	string

Response samples

200

Content type

application/json

{"error": 0,
"msg": "License converted successfully",
"license_converted": 0,
"license_convert_old_plan": 0,
"license_convert_new_plan": 3,
"license_convert_old_price": 0,
"license_convert_new_price": 9.99,
"license_convert_old_price_days": 2,
"license_convert_new_price_days": 28,
"license_convert_total_days": 30,
"hitsteps_share": 0,
"license_plan_id": 3,
"license_plan_name": "Pro",
"license_plan_months": 12,
"license_expiry": 1234623540,
"license_expiry_processed": "2016-09-16"
}

Return list of plans available for purchase

Return list of plans available for purchase along with the pricing set by whitelabel brand.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer

Responses

Response Schema: application/json

	object
	object

Response samples

200

Content type

application/json

{"0": {"id": "0",
"name": "Starter",
"price": "8",
"hit": "10000",
"hit_label": "10k/mo",
"sites": "2",
"history": "30",
"goal": "3",
"chat": "1",
"chat_agent": "1",
"https": "1",
"label": "3",
"social": "0",
"heatmap_click": "0",
"heatmap_days": "0",
"uptime": "0",
"uptime_credits": "0",
"y2price": 95.81,
"yprice": 53.89,
"mo9price": 41.53,
"mo6price": 28.44
},
"-1": {"id": "-1",
"name": "Free",
"price": "0",
"hit": "2000",
"hit_label": "2k/mo",
"sites": "1",
"history": "14",
"goal": "0",
"chat": "0",
"chat_agent": "0",
"https": "1",
"label": "0",
"social": "0",
"heatmap_click": "0",
"heatmap_days": "0",
"uptime": "0",
"uptime_credits": "0"
}
}

Analytics

Get last 7 days statistics

Request last 7 days statistics of a website.

Request Body schema: multipart/form-data

token	string
whitelabel_id	integer
website_id	integer

Responses

Response Schema: application/json

	object
	object
	object
	object
	object
	object
	object
error	integer

Response samples

200

Content type

application/json

{"0": {"day": "20150122",
"date": "1379622402",
"visits": "320",
"pageviews": "1609",
"new_visits": "29",
"ref_from_sites": "22",
"ref_from_search": "10",
"ref_direct": "330",
"ref_socialmedia": "1",
"bouncerate": "19"
},
"1": {"day": "20150121",
"date": "1379536001",
"visits": "433",
"pageviews": "1766",
"new_visits": "61",
"ref_from_sites": "32",
"ref_from_search": "23",
"ref_direct": "610",
"ref_socialmedia": "2",
"bouncerate": "21"
},
"2": {"day": "20150120",
"date": "1379449662",
"visits": "436",
"pageviews": "1710",
"new_visits": "46",
"ref_from_sites": "15",
"ref_from_search": "9",
"ref_direct": "448",
"ref_socialmedia": "2",
"bouncerate": "27"
},
"3": {"day": "20150119",
"date": "1379363201",
"visits": "389",
"pageviews": "1471",
"new_visits": "53",
"ref_from_sites": "20",
"ref_from_search": "15",
"ref_direct": "405",
"ref_socialmedia": "1",
"bouncerate": "28"
},
"4": {"day": "20150118",
"date": "1379276801",
"visits": "357",
"pageviews": "1589",
"new_visits": "49",
"ref_from_sites": "20",
"ref_from_search": "10",
"ref_direct": "476",
"ref_socialmedia": "2",
"bouncerate": "24"
},
"5": {"day": "20150117",
"date": "1379190581",
"visits": "403",
"pageviews": "1800",
"new_visits": "60",
"ref_from_sites": "30",
"ref_from_search": "8",
"ref_direct": "516",
"ref_socialmedia": "2",
"bouncerate": "27"
},
"6": {"day": "20150116",
"date": "1379104001",
"visits": "393",
"pageviews": "1973",
"new_visits": "64",
"ref_from_sites": "40",
"ref_from_search": "13",
"ref_direct": "473",
"ref_socialmedia": "1",
"bouncerate": "30"
},
"error": 0
}

Get a direct link to specified service

Return direct link to specified services in whitelabel domain:

dashboard
livemap
onlineusers
recentpageviews
popularpages
topentrypages
topexitpages
downloads
downloadactivity
chat
users
departments
shortcuts
chatsettings
overview
recentvisitors
loyalvisitors
uniquevisitors
topcountry
visitormap
averagetraffic
excludeip
exportcsv
browseros
resolution
language
cookie
cpu
timezone
recentreferral
topreferral
socialmedia
blockreferral
exitlink
exitlinkactivity
searchengine
keywordanalysis
recentkeywords
keywordtrends
labels
newlabel
goals
newgoal
campaigns
newcampaign
sitesetting
accountsetting
listmysites

Request Body schema: multipart/form-data

whitelabel_id	integer
token	string
website_id	integer
reportname	string

Responses

Response Schema: application/json

error	integer
autologin_url	string
simple_url	string

Response samples

200

Content type

application/json

{"error": 0,
"autologin_url": "http://whitelabel.brand/login.php?code=b123432433&service=dashboard",
"simple_url": "http://whitelabel.brand/stats/34234/dashboard"
}