API Documentation

Getting Started

The MixRank API is a REST interface to much of the data available in MixRank reports. URL endpoints are resource-oriented and all results, including errors, are returned in JSON format. Appropriate HTTP status codes are returned to represent success and error results.

The API is very simple to use with only an HTTP client and a JSON parser, so there's no need for any client libraries.

Authentication

You'll need an API key to make any requests. Request API Access and we'll be in touch to help you get started.

Please keep your key secret; requests made with your key will identify you! If your key is compromised, please ask us for a replacement.

To verify your key, you can visit https://api.mixrank.com/v2/json/{api_key}/echo. You can also go to the Authentication section and click the button to test your API key.

Usage Limits

The number of requests you can make is determined by your API license. If you're unsure what your limit is, please ask us. Exceeding the request limit may result in a service interruption.

Your API license also determines what parts of the API are accessible; everything isn't available by default. Let us know if you have any questions about what you can and can't acccess.

Request Format

All API endpoints will start with https://api.mixrank.com/v2/json/{api_key}/ followed by a query path. Required parameters will be embedded in the endpoint format, and optional parameters must be appended in the URL query string.

For example, disecting the URL: https://api.mixrank.com/v2/json/{api_key}/advertisers/livingsocial.com/gdn/textads?page_size=10&offset=10

livingsocial.com This is a required parameter embedded in the endpoint URL.

page_size This is an optional parameter, overriding a default. The page_size parameter determines the maximum number of results returned. The maximum page size for all requests is 100.

offset This is another optional parameter, overriding a default. The offset parameter is useful for paging through results.

Note that optional parameter names are case-sensitive. In the example above, if Page_Size was used instead of page_size, the parameter would be ignored.

Parameters that specify a date should always be passed in ISO 8601 format, i.e. "YYYY-MM-DD".

Response Format

All responses are returned as JSON. If there are errors they will be available in the "errors" field of the response and the appropriate HTTP status code will be returned.

All dates will be returned in ISO 8601 format (i.e. YYYY-MM-DD).

If any fields in the response are empty, they will be returned as null.

Authentication / Echo

Test that your API key is valid.

Synopsis

GET /echo

Response

Path	Type	Summary
status	str	"success" if your API key is valid.

Examples

GET Hide

Check your API key.
/echo

Companies / Directory

Directory of companies.

Synopsis

GET /companies

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rank`, `employee_count`, `id`.			rank
search	Term to search for

Response

Path	Type	Summary
address	object	Primary address for this company.
address.city	str	City of this company
address.country	str	Country of this company
address.postal_code	str	Postal routing code of this company
address.region	str	State, Province, etc. of this company
address.street_address	str	Street address of this company
appstore	object	Objects in the Apple Appstore
appstore.app_count	int	number of iOS apps published by this company.
appstore.sdk_count	int	number of iOS SDKs produced by this company.
employees	int	Number of current employees at this company.
id	int	Company ID.
industries	list[object]	LinkedIn company industries.
industries[].id	int	Industry ID
industries[].is_primary	bool	Whether or not this is a primary industry that this company is involved in
industries[].name	str	Industry name
linkedin	object	LinkedIn company profile.
linkedin.id	int	LinkedIn company ID.
linkedin.url	str	City of this company
naics	list[object]	North American Industry Classification System codes for this company.
naics[].id	str	Industry ID
naics[].name	str	Industry name
name	str	Company name.
playstore	object	Objects in the Google Play Store
playstore.app_count	int	number of Android apps published by this company.
playstore.sdk_count	int	number of Android SDKs produced by this company.
rank	int	MixRank Rank.
rank_fortune	int	Fortune Rank
rank_incmagazine	int	Inc. 5000 Rank
rank_internetretailer	int	Internet Retailer Rank
score	float	MixRank Authority Score™.
sic	list[object]	Standard Industry Classification codes for this company.
sic[].id	str	Industry ID
sic[].name	str	Industry name
slug	str	A unique textual identifier for this company
web	object	Objects on the web
web.site_count	int	number of websites published by this company.
web.tag_count	int	number of Web Tags produced by this company.

Examples

GET Hide

Top 4 companies by number of employees.
/companies?page_size=4

GET Hide

Search for companies matching "rovio".
/companies?search=rovio

Companies / Overview

Summary information about a company.

Synopsis

GET /companies/{company_id}

Required Parameters

Name	Summary
company_id	The ID of the company.

Response

Path	Type	Summary
address	object	Primary address for this company.
address.city	str	City of this company
address.country	str	Country of this company
address.postal_code	str	Postal routing code of this company
address.region	str	State, Province, etc. of this company
address.street_address	str	Street address of this company
appstore	object	Objects in the Apple Appstore
appstore.app_count	int	number of iOS apps published by this company.
appstore.sdk_count	int	number of iOS SDKs produced by this company.
employees	int	Number of current employees at this company.
id	int	Company ID.
industries	list[object]	LinkedIn company industries.
industries[].id	int	Industry ID
industries[].is_primary	bool	Whether or not this is a primary industry that this company is involved in
industries[].name	str	Industry name
linkedin	object	LinkedIn company profile.
linkedin.id	int	LinkedIn company ID.
linkedin.url	str	City of this company
naics	list[object]	North American Industry Classification System codes for this company.
naics[].id	str	Industry ID
naics[].name	str	Industry name
name	str	Company name.
playstore	object	Objects in the Google Play Store
playstore.app_count	int	number of Android apps published by this company.
playstore.sdk_count	int	number of Android SDKs produced by this company.
rank	int	MixRank Rank.
rank_fortune	int	Fortune Rank
rank_incmagazine	int	Inc. 5000 Rank
rank_internetretailer	int	Internet Retailer Rank
score	float	MixRank Authority Score™.
sic	list[object]	Standard Industry Classification codes for this company.
sic[].id	str	Industry ID
sic[].name	str	Industry name
slug	str	A unique textual identifier for this company
web	object	Objects on the web
web.site_count	int	number of websites published by this company.
web.tag_count	int	number of Web Tags produced by this company.

Examples

GET Hide

Company information for Google, Inc.
/companies/81760867

Companies / Match

Query the companies databases for best matches. Results ordered by relevance.

Synopsis

GET /companies/match

Optional Parameters

Name	Summary	Min	Max	Default
name	Company name.
url	Domain name, website url.
linkedin	Company's LinkedIn url.

Response

Path	Type	Summary
address	object	Primary address for this company.
address.city	str	City of this company
address.country	str	Country of this company
address.postal_code	str	Postal routing code of this company
address.region	str	State, Province, etc. of this company
address.street_address	str	Street address of this company
appstore	object	Objects in the Apple Appstore
appstore.app_count	int	number of iOS apps published by this company.
appstore.sdk_count	int	number of iOS SDKs produced by this company.
employees	int	Number of current employees at this company.
id	int	Company ID.
industries	list[object]	LinkedIn company industries.
industries[].id	int	Industry ID
industries[].is_primary	bool	Whether or not this is a primary industry that this company is involved in
industries[].name	str	Industry name
linkedin	object	LinkedIn company profile.
linkedin.id	int	LinkedIn company ID.
linkedin.url	str	City of this company
naics	list[object]	North American Industry Classification System codes for this company.
naics[].id	str	Industry ID
naics[].name	str	Industry name
name	str	Company name.
playstore	object	Objects in the Google Play Store
playstore.app_count	int	number of Android apps published by this company.
playstore.sdk_count	int	number of Android SDKs produced by this company.
rank	int	MixRank Rank.
rank_fortune	int	Fortune Rank
rank_incmagazine	int	Inc. 5000 Rank
rank_internetretailer	int	Internet Retailer Rank
score	float	MixRank Authority Score™.
sic	list[object]	Standard Industry Classification codes for this company.
sic[].id	str	Industry ID
sic[].name	str	Industry name
slug	str	A unique textual identifier for this company
web	object	Objects on the web
web.site_count	int	number of websites published by this company.
web.tag_count	int	number of Web Tags produced by this company.

Examples

GET Hide

Find best match to company name "Xerox".
/companies/match?name=Xerox

GET Hide

Match "MAXDigital LLC".
/companies/match?name=MAXDigital%20LLC

GET Hide

Match "UNC-Chapel Hill".
/companies/match?name=UNC-Chapel%20Hill

GET Hide

Find by website url.
/companies/match?url=https://guardian.co.uk/

GET Hide

Find by LinkedIn url.
/companies/match?linkedin=https://linkedin.com/company/157355

GET Hide

Find by LinkedIn url.
/companies/match?linkedin=https://linkedin.com/company/gameloft

iOS Apps / Directory

Directory of iOS apps.

Synopsis

GET /appstore/apps

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rank`, `rating_count`, `release_date`, `configs_count`, `id`.			rank
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc
company.id	Filter results by company ID.
search	Term to search for

Response

Path	Type	Summary
bundle_id	str	The unique string identifier for this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
company_url	str	Company website.
configs_count	int	The number of configuration properties extracted from the app's info.plist (across all inspected versions).
content_rating	str	Content safety rating.
copyright	str	App's copyright notice.
developer	str	The name of the app developer.
developer_id	int	ID of the developer.
downloaded	bool	Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
genre	str	Genre this app is in.
genres	str	Sub-genres this app is in.
id	str	The unique integer identifier for this app.
large_artwork_url	str	100x100 app icon.
privacy_policy_url	str	App's privacy policy.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the first version of this app.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
seller	str	The name of the app seller.
small_artwork_url	str	57x57 app icon.
support_url	str	Support website.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.version_number	str	Unique identifier of binary
version.version_string	str	Human-friendly version

Examples

GET Hide

Top 4 apps by ratings.
/appstore/apps?page_size=4&sort_field=rating_count

GET Hide

The oldest apps in the appstore.
/appstore/apps?page_size=4&sort_field=id&sort_order=asc

GET Hide

iOS apps released by Supercell.
/appstore/apps?company.id=82018021

GET Hide

Search for apps matching "zombies".
/appstore/apps?search=zombies

iOS Apps / Overview

Summary information about a Play Store app.

Synopsis

GET /appstore/apps/{app_id}

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Response

Path	Type	Summary
bundle_id	str	The unique string identifier for this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
company_url	str	Company website.
compatibility	object	Restrictions on Supported Devices
compatibility.min_ios_version	str
compatibility.supported_devices	list[str]
configs_count	int	The number of configuration properties extracted from the app's info.plist (across all inspected versions).
content_rating	str	Content safety rating.
copyright	str	App's copyright notice.
developer	str	The name of the app developer.
developer_id	int	ID of the developer.
developer_link	str	Developer's itunes profile.
downloaded	bool	Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
genre	str	Genre this app is in.
genres	str	Sub-genres this app is in.
id	str	The unique integer identifier for this app.
installation_size	int	Size of the app in bytes.
ipad_screenshot_urls	list[str]	Screenshots for iPad.
large_artwork_url	str	100x100 app icon.
price	str	Price for this app in US appstore.
privacy_policy_url	str	App's privacy policy.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
ratings	object	Number of ratings per star.
ratings.1	int
ratings.2	int
ratings.3	int
ratings.4	int
ratings.5	int
release_date	date	The upload date for the first version of this app.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
screenshot_urls	list[str]	Screenshots for iPhone, iPod.
seller	str	The name of the app seller.
small_artwork_url	str	57x57 app icon.
summary	str	The desciption of this app
support_url	str	Support website.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.version_number	str	Unique identifier of binary
version.version_string	str	Human-friendly version

Examples

GET Hide

Summary information for Facebook.
/appstore/apps/284882215

GET Hide

Summary information for Pandora.
/appstore/apps/com.pandora

iOS Apps / Rankings Summary

Rankings for an app. Apps are ranked in "lists" which are made up of a container, a country, and a genre.

Synopsis

GET /appstore/apps/{app_id}/rankings

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4

Response

Path	Type	Summary
container	str	List container.
country	str	List country.
current_rank	int	The current rank the app is at in this list.
first_ranked	date	The date this app first ranked in this list.
genre	str	List genre.
highest_rank	int	The highest rank the app achieved in this list.
id	int	List ID.
last_ranked	date	The date this app last ranked in this list.

Examples

GET Hide

Rankings for Starbucks.
/appstore/apps/331177714/rankings

GET Hide

Rankings for Starbucks.
/appstore/apps/com.starbucks.mystarbucks/rankings

iOS Apps / Rankings History

Ranking historys for an app in a given ranking list.

Synopsis

GET /appstore/apps/{app_id}/rankings-history

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID
container	Container name from /appstore/rankings.
genre	Category name from /appstore/rankings.
country	Category name from /appstore/rankings.

Optional Parameters

Name	Summary	Min	Max	Default
before	Return rankings before given date (in UTC).
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4

Response

Path	Type	Summary
date	datetime	When this ranking list was generated by Apple (UTC).
ranking	int	The current rank of this app at this time.

Examples

GET Hide

Rankings history for Shazam in the "Top Free Applications" list in the US.
/appstore/apps/284993459/rankings-history?container=topfreeapplications&genre=ios&country=us

GET Hide

Rankings history for "Clash of Clans" in the "Top Free Applications" list in the US.
/appstore/apps/com.supercell.magic/rankings-history?container=topfreeapplications&genre=ios&country=us

iOS Apps / SDKs

SDKs installed in a given app.

Synopsis

GET /appstore/apps/{app_id}/sdks

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `version_code_min`, `version_code_max`, `name`, `slug`.			version_code_min
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
currently_installed	bool	Indicates if the SDK is currently installed in the app.
name	str	Name of the SDK.
slug	str	ID of the SDK.
upload_date_max	date	The upload date of the newest version of the app with this SDK installed.
upload_date_min	date	The upload date of the oldest version of the app with this SDK installed.
version_code_max	int	The newest version of the app we've observed with this SDK.
version_code_min	int	The oldest version of the app we've observed with this SDK.

Examples

GET Hide

SDKs installed in Instagram.
/appstore/apps/389801252/sdks

GET Hide

SDKs installed in "Clash of Clans".
/appstore/apps/com.supercell.magic/sdks

iOS Apps / Configs

Configuration options for iOS apps from embedded info.plist documents.

Synopsis

GET /appstore/apps/{app_id}/configs

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Response

Path	Type	Summary
plist	str	The plist document embedded in the app.
version	str	The version of the app analyzed.

Examples

GET Hide

Get the config options for Words With Friends.
/appstore/apps/321916506/configs

GET Hide

Get the config options for Words With Friends.
/appstore/apps/com.newtoyinc.WordsWithFriendsFree/configs

iOS Apps / Versions

Releases of an app.

Synopsis

GET /appstore/apps/{app_id}/versions

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `id`.			id
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
asset_size	int	Size of IPA in bytes.
class_count	int	Number of classes in binary.
config_count	int	Number of Info.plist configs.
id	int	Version ID (unique globally).
release_date	date	Date this version was released to the store.
release_notes	str	Developer's release notes.
resource_count	int	Number of files in bundle.
version_display	str	Human-friendly version number.

Examples

GET Hide

Versions of Pinterest app.
/appstore/apps/429047995/versions

GET Hide

Versions of "Clash of Clans" app.
/appstore/apps/com.supercell.magic/versions

iOS Apps / In-App Purchases

In-App purchases offered by this app.

Synopsis

GET /appstore/apps/{app_id}/iaps

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `id`.			id
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
id	int	In-app purchase ID (unique globally).
name	str	Name of in-app purchase.
price_str	str	String-formatted purchase price of in-app purchase.

Examples

GET Hide

In-app purchases offered by "Minecraft".
/appstore/apps/479516143/iaps

GET Hide

In-app purchases offered by "Minecraft".
/appstore/apps/com.mojang.minecraftpe/iaps

iOS Apps / Reviews

User reviews of a given app.

Synopsis

GET /appstore/apps/{app_id}/reviews

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `date`.			date
sort_order	Sort the results in the order specified. Sortable directions: `desc`.			desc

Response

Path	Type	Summary
body	str	Body of the review.
country_id	str	Country code of the store the user downloaded the app from.
date	date	When the user submitted the review.
id	int	Review ID.
rating	int	Star rating (1-5).
title	str	Title of the review.
user_id	int	iTunes user ID.
username	str	iTunes username.
version	str	Version of app the user is reviewing.
vote_no	int	Number of users that voted this review as unhelpful.
vote_yes	int	Number of users that voted this review as helpful.

Examples

GET Hide

Reviews of "Minecraft".
/appstore/apps/479516143/reviews

GET Hide

Reviews of "Minecraft".
/appstore/apps/com.mojang.minecraftpe/reviews

iOS Apps / Downloads

Download trends for a given app.

Synopsis

GET /appstore/apps/{app_id}/downloads

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Response

Path	Type	Summary
country	str	Name of country for downloads timeseries.
data	list[list]	Data for downloads timeseries.

Examples

GET Hide

Downloads trend for "Clash of Clans".
/appstore/apps/529479190/downloads

GET Hide

Downloads trend for "Clash of Clans".
/appstore/apps/com.supercell.magic/downloads

iOS Apps / Revenue

Revenue trends for a given app.

Synopsis

GET /appstore/apps/{app_id}/revenue

Required Parameters

Name	Summary
app_id	The ID of the app - either the MixRank ID or the iOS bundle ID

Response

Path	Type	Summary
country	str	Name of country for revenue timeseries.
data	list[list]	Data for revenue timeseries.

Examples

GET Hide

Revenue trend for "Clash of Clans".
/appstore/apps/529479190/revenue

GET Hide

Revenue trend for "Clash of Clans".
/appstore/apps/com.supercell.magic/revenue

iOS Developers / Apps

Apps published by a developer

Synopsis

GET /appstore/developers/{developer_id}/apps

Required Parameters

Name	Summary
developer_id	The ID of the developer.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rating_count`, `release_date`, `configs_count`, `rating`, `id`.			rating_count
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
bundle_id	str	The unique string identifier for this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
company_url	str	Company website.
configs_count	int	The number of configuration properties extracted from the app's info.plist (across all inspected versions).
content_rating	str	Content safety rating.
copyright	str	App's copyright notice.
developer	str	The name of the app developer.
developer_id	int	ID of the developer.
downloaded	bool	Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
genre	str	Genre this app is in.
genres	str	Sub-genres this app is in.
id	str	The unique integer identifier for this app.
large_artwork_url	str	100x100 app icon.
privacy_policy_url	str	App's privacy policy.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the first version of this app.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
seller	str	The name of the app seller.
small_artwork_url	str	57x57 app icon.
support_url	str	Support website.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.version_number	str	Unique identifier of binary
version.version_string	str	Human-friendly version

Examples

GET Hide

Get the apps developed by OMGPOP.
/appstore/developers/422679887/apps

iOS Rankings / Lists

Get all ranking list options. A list is determined by a container, genre, and country.

Synopsis

GET /appstore/rankings

Response

Path	Type	Summary
containers	list[str]	List of iOS rankings containers, eg "topfreeapplications".
countries	list[str]	List of iOS rankings countries, eg "us".
genres	list[str]	List of iOS genres, eg "ios-games-racing".

Examples

GET Hide

Get all ranking lists.
/appstore/rankings

iOS Rankings / Rankings

Get app rankings by list. A list is determined by container, a genre, and a country.

Synopsis

GET /appstore/rankings/{container}/{genre}/{country}

Required Parameters

Name	Summary
container	Container name from /appstore/rankings.
genre	Category name from /appstore/rankings.
country	Category name from /appstore/rankings.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `ranking`.			ranking
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			asc
before	Return ranking list as it appeared before given date (in UTC).

Response

Path	Type	Summary
bundle_id	str	The unique string identifier for this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
company_url	str	Company website.
configs_count	int	The number of configuration properties extracted from the app's info.plist (across all inspected versions).
content_rating	str	Content safety rating.
copyright	str	App's copyright notice.
developer	str	The name of the app developer.
developer_id	int	ID of the developer.
downloaded	bool	Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
genre	str	Genre this app is in.
genres	str	Sub-genres this app is in.
id	str	The unique integer identifier for this app.
large_artwork_url	str	100x100 app icon.
privacy_policy_url	str	App's privacy policy.
rank	int	MixRank Rank.
ranking	int	The current rank of this app.
ranking_date	datetime	When this ranking list was generated by Apple (UTC).
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the first version of this app.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
seller	str	The name of the app seller.
small_artwork_url	str	57x57 app icon.
support_url	str	Support website.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.version_number	str	Unique identifier of binary
version.version_string	str	Human-friendly version

Examples

GET Hide

Rankings of top free games.
/appstore/rankings/topfreeapplications/ios/us

iOS SDKs / Directory

List of identified SDKs.

Synopsis

GET /appstore/sdks

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `total_installs`, `current_installs`, `uninstalls`.			total_installs
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
current_installs	int	Number of apps that currently have this SDK installed.
name	str	Name of the SDK.
slug	str	Identifies this SDK.
total_installs	int	Number of apps that have ever installed this SDK.
uninstalls	int	Number of apps that have uninstalled this SDK.

Examples

GET Hide

Top 4 SDKs by total installs.
/appstore/sdks?sort_field=total_installs&page_size=4

GET Hide

Top 4 SDKs by uninstalls.
/appstore/sdks?sort_field=uninstalls&page_size=4

iOS SDKs / Overview

Get summary information about an SDK.

Synopsis

GET /appstore/sdks/{sdk_slug}

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Response

Path	Type	Summary
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
current_installs	int	Number of apps that currently have this SDK installed.
description	str	Description of this SDK.
logo_url	str	Logo for the SDK/company.
name	str	Name of this SDK.
publisher_count	int	Number of app publishers that have ever installed this SDK.
slug	str	ID of this SDK.
tags	list[str]	Tags indicating types of SDK.
total_installs	int	Number of apps that have ever installed this SDK.
uninstalls	int	Number of apps that have uninstalled this SDK.
url	str	Usually points to the company or documentation page for this SDK.

Examples

GET Hide

Get information about the Facebook SDK.
/appstore/sdks/facebook

iOS SDKs / Installs

Get apps that have this SDK installed.

Synopsis

GET /appstore/sdks/{sdk_slug}/installs

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rating_count`, `upload_date`, `id`.			rating_count
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
bundle_id	str	The unique string identifier for this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
company_url	str	Company website.
configs_count	int	The number of configuration properties extracted from the app's info.plist (across all inspected versions).
content_rating	str	Content safety rating.
copyright	str	App's copyright notice.
developer	str	The name of the app developer.
developer_id	int	ID of the developer.
downloaded	bool	Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
genre	str	Genre this app is in.
genres	str	Sub-genres this app is in.
id	str	The unique integer identifier for this app.
large_artwork_url	str	100x100 app icon.
privacy_policy_url	str	App's privacy policy.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the first version of this app.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
seller	str	The name of the app seller.
small_artwork_url	str	57x57 app icon.
support_url	str	Support website.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.version_number	str	Unique identifier of binary
version.version_string	str	Human-friendly version

Examples

GET Hide

Top 10 apps that have installed the Flurry SDK.
/appstore/sdks/flurry/installs?page_size=10

GET Hide

Top 10 apps that have installed the Google Analytics SDK.
/appstore/sdks/google-analytics/installs?page_size=10

iOS SDKs / Uninstalls

Get apps that have uninstalled this SDK.

Synopsis

GET /appstore/sdks/{sdk_slug}/uninstalls

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rating_count`, `upload_date`, `id`.			rating_count
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
bundle_id	str	The unique string identifier for this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
company_url	str	Company website.
configs_count	int	The number of configuration properties extracted from the app's info.plist (across all inspected versions).
content_rating	str	Content safety rating.
copyright	str	App's copyright notice.
developer	str	The name of the app developer.
developer_id	int	ID of the developer.
downloaded	bool	Whether this app has been downloaded. Apps that have not been downloaded will not have associated interfaces or SDKs.
genre	str	Genre this app is in.
genres	str	Sub-genres this app is in.
id	str	The unique integer identifier for this app.
large_artwork_url	str	100x100 app icon.
privacy_policy_url	str	App's privacy policy.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the first version of this app.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
seller	str	The name of the app seller.
small_artwork_url	str	57x57 app icon.
support_url	str	Support website.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.version_number	str	Unique identifier of binary
version.version_string	str	Human-friendly version

Examples

GET Hide

Top 10 apps that have uninstalled the Flurry SDK.
/appstore/sdks/flurry/uninstalls?page_size=10

GET Hide

Top 10 apps by number of ratings that have uninstalled the OAuth SDK.
/appstore/sdks/oauth/uninstalls?page_size=10&sort_field=rating_count

iOS SDKs / Genres

Get aggregate genre data for a given SDK's apps.

Synopsis

GET /appstore/sdks/{sdk_slug}/genres

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Response

Path	Type	Summary
current_installs	int	Number of apps that currently have this SDK installed in this genre.
genre	str	The identifier for this genre.
total_installs	int	Number of apps that have ever installed this SDK in this genre.
uninstalls	int	Number of apps that have uninstalled this SDK in this genre.

Examples

GET Hide

Get genre stats for apps that have installed InMobi.
/appstore/sdks/inmobi/genres

GET Hide

Get genre stats for apps that have installed Flurry.
/appstore/sdks/flurry/genres

iOS SDKs / Versions

Releases of an SDK

Synopsis

GET /appstore/sdks/{sdk_slug}/versions

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Response

Path	Type	Summary
authors	object	A mapping of details about the SDK authors
default_subspec	str	The specified list of subspecs names to indicate preferred dependenies
dependencies	list[str]	List of dependencies
description	str	Detailed description beyond what is in the summary
documentation_url	str	Link to SDK documentation
exclude_files	list[str]	List of file-path patterns in exclude_files
frameworks	list[str]	List of dependent system frameworks that are linked against
homepage	str	Homepage link for this SDK
id	int	The unique ID of this entity
ios_deployment_target	str	The minumum deployment targets of the supported platform
libraries	list[str]	List of dependent system libraries that are linked against
license	object	A mapping of details about the SDK license
name	str	The name of the SDK in this version
other_data	object	A mapping of miscellaneous data about this SDK
platform	list[str]	The platform on which this SDK is supported
preserve_paths	list[str]	List of file-path patterns specified preserve_path which should not be removed after being downloaded
private_header_files	list[str]	List of file-path patterns for private header files
public_header_files	list[str]	List of file-path patterns for public header files
requires_arc	bool	Whether this SDK requires ARC (Automatic Reference Counting)
resources	list[str]	List of file-path patterns for included resources
screenshots	list[str]	List of screenshots listed by this SDK
social_media_url	str	Link to the social media page for this SDK
source	object	A mapping of details about the source of this SDK, such as the git repo and tag.
source_files	list[str]	List of file-path patterns for the included source files
summary	str	Summary
vendored_frameworks	list[str]	List of file-path patterns for vendored frameworks that come shipped with the SDK
vendored_libraries	list[str]	List of file-path patterns for vendored libraries
version	str	The version number of the release
weak_frameworks	list[str]	A list of frameworks that the SDK target weakly links against.
xcconfig	object	A mapping of xcconfig entries

Examples

GET Hide

Get the version history for the InMobi SDK
/appstore/sdks/inmobi/versions

GET Hide

Get the version history for the Flurry SDK
/appstore/sdks/flurry/versions

Play Store Apps / Directory

Directory of Play Store (Android) apps.

Synopsis

GET /playstore/apps

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `downloads`, `rating_count`, `pname`.			downloads
company.id	Filter results by company ID.
search	Term to search for

Response

Path	Type	Summary
categories	str	All categories of this app (includes alternates like android_wear).
category	str	The primary category of this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
developer_email	str	Email address of the developer, from the public profile.
developer_id	int	ID of the developer.
developer_name	str	The name of the app publisher. Usually a company or individual's name.
developer_website	str	Developer's website.
downloads	int	The approximate number of downloads for this app.
large_icon_url	str	512x512 app icon.
pname	str	The package name for this app.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the earliest version of this app.
removed	bool	Indicates if this app has been removed from the playstore.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
small_icon_url	str	48x48 app icon.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.major_version_number	int	Major version number.
version.version_code	int	Internal unique version code.
version.version_string	str	User-visible version number.

Examples

GET Hide

Top 4 apps by downloads.
/playstore/apps?page_size=4&sort_field=downloads

GET Hide

Top 4 apps by ratings.
/playstore/apps?page_size=4&sort_field=rating_count

GET Hide

Apps by OMGPOP
/playstore/apps?company.id=81976622

GET Hide

Search for apps matching "messenger".
/playstore/apps?search=messenger

Play Store Apps / Overview

Summary information about a Play Store app.

Synopsis

GET /playstore/apps/{pname}

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Response

Path	Type	Summary
categories	str	All categories of this app (includes alternates like android_wear).
category	str	The primary category of this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
content_rating	int	The content safety rating (1-5). See: https://support.google.com/googleplay/answer/1075738?hl=en.
description_html	str	The HTML description of this app.
developer_email	str	Email address of the developer, from the public profile.
developer_id	int	ID of the developer.
developer_name	str	The name of the app publisher. Usually a company or individual's name.
developer_website	str	Developer's website.
downloads	int	The approximate number of downloads for this app.
installation_size	int	Size of the app in bytes.
large_icon_url	str	512x512 app icon.
permissions	list[str]	List of permissions this app requires.
pname	str	The package name for this app.
prices	list[object]	List of prices for this app in different currencies.
prices[].converted_currency	str
prices[].converted_price	int
prices[].native_currency	str
prices[].native_price	int
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
ratings	object	Number of ratings per star.
ratings.1	int
ratings.2	int
ratings.3	int
ratings.4	int
ratings.5	int
recent_changes_html	str	The recent changes HTML.
release_date	date	The upload date for the earliest version of this app.
removed	bool	Indicates if this app has been removed from the playstore.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
small_icon_url	str	48x48 app icon.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version	object	An object with several fields: major_version_number, version_code (internal unique version code), version_string (pretty version number).
version.major_version_number	int	Major version number.
version.major_version_number	int
version.version_code	int	Internal unique version code.
version.version_code	int
version.version_string	str	User-visible version number.
version.version_string	str

Examples

GET Hide

Summary information for Candy Crush.
/playstore/apps/com.king.candycrushsaga

GET Hide

Summary information for TuneIn Radio.
/playstore/apps/tunein.player

GET Hide

Summary information for WhatsApp.
/playstore/apps/com.whatsapp

Play Store Apps / Images

Get image and video assets for an app. Includes icons and screenshots.

Synopsis

GET /playstore/apps/{pname}/images

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4

Response

Path	Type	Summary
first_seen	date	The date we first observed this app image.
last_seen	date	The date we last observed this app image.
type	object	Meta info about this asset.
url	str	Image url.

Examples

GET Hide

Requests all image and video assets for Candy Crush.
/playstore/apps/com.king.candycrushsaga/images

GET Hide

Requests all image and video assets for Clash of Clans.
/playstore/apps/com.supercell.clashofclans/images

Play Store Apps / Rankings Summary

Rankings for an app. Apps are ranked in "lists" which are made up of a container, and (optionally) a category.

Synopsis

GET /playstore/apps/{pname}/rankings

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `current_rank`, `highest_rank`.			current_rank
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
category	str	The category this app is in.
container	str	List container.
current_rank	int	The current rank the app is at in this list.
first_ranked	date	The date this app first ranked in this list.
highest_rank	int	The highest rank the app achieved in this list.
last_ranked	date	The date this app last ranked in this list.

Examples

GET Hide

Rankings for Deer Hunter 2014.
/playstore/apps/com.glu.deerhunt2/rankings

GET Hide

Rankings for WolframAlpha.
/playstore/apps/com.wolfram.android.alpha/rankings

Play Store Apps / Rankings History

Ranking historys for an app in a given ranking list.

Synopsis

GET /playstore/apps/{pname}/rankings-history

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".
container	Container name from /playstore/rankings.

Optional Parameters

Name	Summary	Min	Max	Default
category	Category name from /playstore/rankings.
before	Return rankings before given date (in UTC).
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4

Response

Path	Type	Summary
date	datetime	When this ranking list was generated by Google (UTC).
ranking	int	The current rank of this app at this time.

Examples

GET Hide

Rankings for Netflix in Top Grossing.
/playstore/apps/com.netflix.mediaclient/rankings-history?container=apps_topgrossing

GET Hide

Rankings for Netflix in Top Grossing before 2017.
/playstore/apps/com.netflix.mediaclient/rankings-history?container=apps_topgrossing&before=2017-01-01

Play Store Apps / SDKs

SDKs installed in a given app.

Synopsis

GET /playstore/apps/{pname}/sdks

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `version_code_min`, `version_code_max`, `slug`.			version_code_min
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
currently_installed	bool	Indicates if the SDK is currently installed in the app.
name	str	Name of the SDK.
slug	str	ID of the SDK.
upload_date_max	date	The upload date of the newest version of the app with this SDK installed.
upload_date_min	date	The upload date of the oldest version of the app with this SDK installed.
version_code_max	int	The newest version of the app we've observed with this SDK.
version_code_min	int	The oldest version of the app we've observed with this SDK.

Examples

GET Hide

SDKs installed in Pocket Bingo.
/playstore/apps/com.apostek.apps.pocketbingo/sdks?page_size=10

GET Hide

SDKs installed in Shazam.
/playstore/apps/com.shazam.android/sdks?page_size=10

Play Store Apps / Namespaces

Namespaces present in a given app.

Synopsis

GET /playstore/apps/{pname}/namespaces

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `version_code_min`, `version_code_max`, `namespace`.			version_code_min
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
currently_installed	bool	Indicates if the namespace is currently present in the app.
namespace	str	The namespace name.
upload_date_max	date	The upload date of the newest version of the app with this namespace present.
upload_date_min	date	The upload date of the oldest version of the app with this namespace present.
version_code_max	int	The newest version of the app we've observed with this namespace present.
version_code_min	int	The oldest version of the app we've observed with this namespace present.

Examples

GET Hide

Get the namespaces in PicsArt.
/playstore/apps/com.picsart.studio/namespaces

GET Hide

Get the namespaces in Instagram.
/playstore/apps/com.instagram.android/namespaces

Play Store Apps / Versions

Releases of an app.

Synopsis

GET /playstore/apps/{pname}/versions

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `version_code`.			version_code
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
asset_size	int	Size of IPA in bytes.
downloaded	bool	Indicates if the APK has been downloaded.
id	int	Version ID (unique per app).

Examples

GET Hide

Versions of Viber.
/playstore/apps/com.viber.voip/versions?page_size=10

Play Store Apps / APKs

APK files (aka "splits").

Synopsis

GET /playstore/apps/{pname}/versions/{version_code}/apks

Required Parameters

Name	Summary
pname	The package name of the app. The package name is a dotted Java namespace, e.g. "com.mixrank.android".

Optional Parameters

Name	Summary	Min	Max	Default
version_code	The unique integer version code.

Response

Path	Type	Summary
byte_size	int	Size of APK split in bytes.
download_at	date	Date this APK split was downloaded.
id	int	Unique ID.
md5	str	MD5 hash of file.
name	str	APK split filename.
namespace_count	int	Java namespace count.
permission_count	int	Android permission count.
s3uri	str	Path in s3 to access download this APK split file.
sha1	str	SHA1 hash of file.
sha256	str	SHA256 hash of file.

Examples

GET Hide

Viber version 640581.
/playstore/apps/com.viber.voip/versions/640581/apks

Play Store Developers / Apps

Apps published by a developer

Synopsis

GET /playstore/developers/{developer_id}/apps

Required Parameters

Name	Summary
developer_id	The ID of the developer.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `downloads`, `rating_count`, `pname`.			downloads
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
categories	str	All categories of this app (includes alternates like android_wear).
category	str	The primary category of this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
developer_email	str	Email address of the developer, from the public profile.
developer_id	int	ID of the developer.
developer_name	str	The name of the app publisher. Usually a company or individual's name.
developer_website	str	Developer's website.
downloads	int	The approximate number of downloads for this app.
large_icon_url	str	512x512 app icon.
pname	str	The package name for this app.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the earliest version of this app.
removed	bool	Indicates if this app has been removed from the playstore.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
small_icon_url	str	48x48 app icon.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.major_version_number	int	Major version number.
version.version_code	int	Internal unique version code.
version.version_string	str	User-visible version number.

Examples

GET Hide

Get the apps developed by Rovio Mobile Ltd.
/playstore/developers/358123/apps

Play Store Rankings / Lists

Get all ranking lists.

Synopsis

GET /playstore/rankings

Response

Path	Type	Summary
category	str	The category within this container.
container	str	The name of this container.

Examples

GET Hide

Get all ranking lists.
/playstore/rankings

Play Store Rankings / Rankings

Get app rankings by list. A list is determined by container and (optionally) a category.

Synopsis

GET /playstore/rankings/{container}

Required Parameters

Name	Summary
container	Container name from /playstore/rankings.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `ranking`.			ranking
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			asc
category	Category name from /playstore/rankings.
before	Return ranking list as it appeared before given date (in UTC).

Response

Path	Type	Summary
categories	str	All categories of this app (includes alternates like android_wear).
category	str	The primary category of this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
developer_email	str	Email address of the developer, from the public profile.
developer_id	int	ID of the developer.
developer_name	str	The name of the app publisher. Usually a company or individual's name.
developer_website	str	Developer's website.
downloads	int	The approximate number of downloads for this app.
large_icon_url	str	512x512 app icon.
pname	str	The package name for this app.
rank	int	MixRank Rank.
ranking	int	Rank within the list.
ranking_date	datetime	When this ranking list was generated by Google (UTC).
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the earliest version of this app.
removed	bool	Indicates if this app has been removed from the playstore.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
small_icon_url	str	48x48 app icon.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.major_version_number	int	Major version number.
version.version_code	int	Internal unique version code.
version.version_string	str	User-visible version number.

Examples

GET Hide

Rankings of trending apps.
/playstore/rankings/apps_movers_shakers

GET Hide

Rankings of top grossing arcade games.
/playstore/rankings/apps_topgrossing?category=game_arcade

Play Store SDKs / Directory

List of identified SDKs.

Synopsis

GET /playstore/sdks

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `total_installs`, `current_installs`, `uninstalls`, `slug`.			total_installs
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
current_installs	int	Number of apps that currently have this SDK installed.
name	str	Name of the SDK.
slug	str	Identifies this SDK.
total_installs	int	Number of apps that have ever installed this SDK.
uninstalls	int	Number of apps that have uninstalled this SDK.

Examples

GET Hide

Top 4 SDKs by total installs.
/playstore/sdks?sort_field=total_installs&page_size=4

GET Hide

Top 4 SDKs by uninstalls.
/playstore/sdks?sort_field=uninstalls&page_size=4

Play Store SDKs / Overview

Get summary information about an SDK.

Synopsis

GET /playstore/sdks/{sdk_slug}

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Response

Path	Type	Summary
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
current_installs	int	Number of apps that currently have this SDK installed.
description	str	Description of this SDK.
logo_url	str	Logo for the SDK/company.
name	str	Name of this SDK.
publisher_count	int	Number of app publishers that have ever installed this SDK.
slug	str	ID of this SDK.
tags	list[str]	Tags indicating types of SDK.
total_installs	int	Number of apps that have ever installed this SDK.
uninstalls	int	Number of apps that have uninstalled this SDK.
url	str	Usually points to the company or documentation page for this SDK.

Examples

GET Hide

Get information about the Square SDK.
/playstore/sdks/square

GET Hide

Get information about the StartApp SDK.
/playstore/sdks/startapp

Play Store SDKs / Installs

Get apps that have this SDK installed.

Synopsis

GET /playstore/sdks/{sdk_slug}/installs

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `downloads`, `rating_count`, `pname`.			downloads
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
categories	str	All categories of this app (includes alternates like android_wear).
category	str	The primary category of this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
developer_email	str	Email address of the developer, from the public profile.
developer_id	int	ID of the developer.
developer_name	str	The name of the app publisher. Usually a company or individual's name.
developer_website	str	Developer's website.
downloads	int	The approximate number of downloads for this app.
large_icon_url	str	512x512 app icon.
pname	str	The package name for this app.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the earliest version of this app.
removed	bool	Indicates if this app has been removed from the playstore.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
small_icon_url	str	48x48 app icon.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.major_version_number	int	Major version number.
version.version_code	int	Internal unique version code.
version.version_string	str	User-visible version number.

Examples

GET Hide

Top 10 apps that have installed the PayPal SDK.
/playstore/sdks/paypal/installs?page_size=10

GET Hide

Top 10 apps that have installed the Google Analytics SDK.
/playstore/sdks/google-analytics/installs?page_size=10

Play Store SDKs / Uninstalls

Get apps that have uninstalled this SDK.

Synopsis

GET /playstore/sdks/{sdk_slug}/uninstalls

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `downloads`, `rating_count`, `pname`.			downloads
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
categories	str	All categories of this app (includes alternates like android_wear).
category	str	The primary category of this app.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
developer_email	str	Email address of the developer, from the public profile.
developer_id	int	ID of the developer.
developer_name	str	The name of the app publisher. Usually a company or individual's name.
developer_website	str	Developer's website.
downloads	int	The approximate number of downloads for this app.
large_icon_url	str	512x512 app icon.
pname	str	The package name for this app.
rank	int	MixRank Rank.
rating	float	The current rating for this app. (0-5)
rating_count	int	Number of ratings for this app.
release_date	date	The upload date for the earliest version of this app.
removed	bool	Indicates if this app has been removed from the playstore.
review_count	int	Number of reviews/comments for this app.
score	float	MixRank Authority Score™.
small_icon_url	str	48x48 app icon.
title	str	The title of the app.
upload_date	date	The upload date for the latest version of this app.
version	object	Latest version information.
version.major_version_number	int	Major version number.
version.version_code	int	Internal unique version code.
version.version_string	str	User-visible version number.

Examples

GET Hide

Top 10 apps that have uninstalled the Flurry SDK.
/playstore/sdks/flurry/uninstalls?page_size=10

GET Hide

Top 10 apps by number of ratings that have uninstalled Millennial Media.
/playstore/sdks/millennial-media/uninstalls?page_size=10&sort_field=rating_count

Play Store SDKs / Categories

Get aggregate category data for a given SDK's apps.

Synopsis

GET /playstore/sdks/{sdk_slug}/categories

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Response

Path	Type	Summary
category	str	The identifier for this category.
current_installs	int	Number of apps that currently have this SDK installed in this category.
total_installs	int	Number of apps that have ever installed this SDK in this category.
uninstalls	int	Number of apps that have uninstalled this SDK in this category.

Examples

GET Hide

Get category stats for apps that have installed InMobi.
/playstore/sdks/inmobi/categories

GET Hide

Get category stats for apps that have installed Flurry.
/playstore/sdks/flurry/categories

Play Store SDKs / Downloads

Get aggregate download data for a given SDK's apps, broken out by download bucket.

Synopsis

GET /playstore/sdks/{sdk_slug}/downloads

Required Parameters

Name	Summary
sdk_slug	The ID of the SDK.

Response

Path	Type	Summary
current_installs	int	Number of apps that currently have this SDK installed in this download bucket.
downloads	int	The lower bound for this download bucket.
total_installs	int	Number of apps that have ever installed this SDK in this download bucket.
uninstalls	int	Number of apps that have uninstalled this SDK in this download bucket.

Examples

GET Hide

Get download stats for apps that have installed the Facebook SDK.
/playstore/sdks/facebook/downloads

GET Hide

Get download stats for apps that have installed the In-app purchases SDK.
/playstore/sdks/google-play-in-app-billing/downloads

Websites / Directory

Directory of websites.

Synopsis

GET /web/sites

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rank`, `id`.			rank
company.id	Filter results by company ID.
search	Term to search for

Response

Path	Type	Summary
alexa_rank	int	Alexa Rank.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
domain	str	The website domain name.
rank	int	MixRank Rank.
score	float	MixRank Authority Score™.

Examples

GET Hide

Websites by Barns and Noble
/web/sites?company.id=81765662

GET Hide

Search for websites matching "chocolate".
/web/sites?search=chocolate

Websites / Overview

Summary information about a website.

Synopsis

GET /web/sites/{domain}

Required Parameters

Name	Summary
domain	The domain name of a website. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Response

Path	Type	Summary
alexa_rank	int	Alexa Rank.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
domain	str	The website domain name.
rank	int	MixRank Rank.
score	float	MixRank Authority Score™.

Examples

GET Hide

Summary information for google.com.
/web/sites/google.com

Websites / Tags

Tags installed on a given website.

Synopsis

GET /web/sites/{domain}/tags

Required Parameters

Name	Summary
domain	The domain name of a website. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4

Response

Path	Type	Summary
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
id	int	ID of the tag.
name	str	Name of the tag.
slug	str	Textual ID of the SDK.
times_seen	int	Times this tag has been observed on this site.

Examples

GET Hide

Tags found on Toys R Us.
/web/sites/toysrus.com/tags

Web Tags / Overview

Summary information about a web tag.

Synopsis

GET /web/tags/{slug}

Required Parameters

Name	Summary
slug	The textual ID of the tag.

Response

Path	Type	Summary
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
description	str	Description of the tag.
id	int	ID of the tag.
logo_url	str	Logo for this tag.
name	str	Name of the tag.
site_count	str	Number of websites found with this tag.
slug	str	Textual ID of the SDK.
url	str	URL reference for more information.

Examples

GET Hide

Summary information for Criteo tag.
/web/tags/adroll

Web Tags / Sites

Web sites that use a given tag.

Synopsis

GET /web/tags/{slug}/sites

Required Parameters

Name	Summary
slug	The textual ID of the tag.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `rank`, `id`.			rank

Response

Path	Type	Summary
alexa_rank	int	Alexa Rank.
company	object	Information about the company associated with this object
company.id	int	The unique integer identifier for this company
company.name	str	The name of this company
company.slug	str	A unique textual identifier for this company
domain	str	The website domain name.
rank	int	MixRank Rank.
score	float	MixRank Authority Score™.

Examples

GET Hide

Websites that use Adroll.
/web/tags/adroll/sites

Advertisers / Overview

Summary information about an advertiser.

Synopsis

GET /advertisers/{advertiser}

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Response

Path	Type	Summary
advertiser	str
display_publisher_count	int	The number of unique web publishers we've observed for this advertiser.
first_seen	date	The date we first observed observed this advertiser's ads.
gdn_display_ad_count	int	The number of unique banners.
gdn_display_ad_first_seen	date	The date we first observed this advertiser's banners.
gdn_display_ad_last_seen	date	The date we last observed this advertiser's banners.
gdn_display_ad_times_seen	int	The number of times we've observed this advertiser's banners.
gdn_keyword_count	int	The number of unique keywords we've observed for this advertiser.
gdn_text_ad_count	int	The number of text ad creatives.
gdn_text_ad_first_seen	date	The date we first observed this advertiser's text ads.
gdn_text_ad_last_seen	date	The date we last observed this advertiser's text ads.
gdn_text_ad_times_seen	int	The number of times we've observed this advertiser's text ads.
landing_page_count	int	The number of unique landing pages we've observed for this advertiser.
last_seen	date	The date we last observed observed this advertiser's ads.
rank	int	Global rank of this advertiser.
times_seen	int	The number of times we've observed this advertiser's ads.

Examples

GET Hide

Get summary of dell.com.
/advertisers/dell.com

GET Hide

Get summary of playstation.com.
/advertisers/playstation.com

GET Hide

Get summary of softlayer.com.
/advertisers/softlayer.com

Advertisers / Banners

Get banner ads for an advertiser.

Synopsis

GET /advertisers/{advertiser}/gdn/displayads

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str	The advertiser.
content_type	str	The file extension, e.g. swf, jpg, gif.
file_size	int	The size of the creative in bytes.
first_seen	date	The first time we observed this ad.
format	object	Creative format type.
format.height	str	Height of the creative.
format.type	str	Creative format name.
format.width	str	Width of the creative.
hash	str	Unique id of this ad.
last_seen	date	The last time we observed this ad.
media_url	str	A URL to download the creative.
times_seen	int	The number of times we have observed this ad.

Examples

GET Hide

Nike's most active banner ads.
/advertisers/nike.com/gdn/displayads?sort_field=times_seen

GET Hide

Ford's recently launched banner ads.
/advertisers/ford.com/gdn/displayads?sort_field=first_seen

Advertisers / Text Ads

Get GDN text ads for an advertiser.

Synopsis

GET /advertisers/{advertiser}/gdn/textads

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `avg_position`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str	The advertiser.
avg_position	float	Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
body	str	The subtitle of the ad.
display_url	str	The display url of the ad (visible to the user).
first_seen	date	The first time we observed this ad.
hash	str	Unique id of this ad.
last_seen	date	The last time we observed this ad.
times_seen	int	The number of times we have observed this ad.
title	str	The title of the ad.

Examples

GET Hide

Domino's top text ads.
/advertisers/dominos.com/gdn/textads

GET Hide

Dropbox's recently added text ads.
/advertisers/dropbox.com/gdn/textads?sort_field=first_seen&sort_order=desc

GET Hide

UC Berkeley's most recently active text ads.
/advertisers/berkeley.edu/gdn/textads?sort_field=last_seen&sort_order=desc

Advertisers / Keywords

Get an advertiser's contextual keywords.

Synopsis

GET /advertisers/{advertiser}/gdn/keywords

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
first_seen	date	The first time we observed the advertiser's ads match this keyword.
keyword	str
last_seen	date	The last time we observed the advertiser's ads match this keyword.
times_seen	int	The number of times we observed the advertiser's ads match this keyword.

Examples

GET Hide

Starbucks Coffee's keywords.
/advertisers/starbucks.com/gdn/keywords

GET Hide

LowerMyBills' most active keywords.
/advertisers/lowermybills.com/gdn/keywords

GET Hide

23andMe's recently observed keywords.
/advertisers/23andme.com/gdn/keywords?sort_field=last_seen&sort_order=desc

Advertisers / Publishers

Get an advertiser's publishers.

Synopsis

GET /advertisers/{advertiser}/gdn/publishers

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
first_seen	date	The first time we observed the advertiser's ads on this publisher.
last_seen	date	The last time we observed the advertiser's ads on this publisher.
monthly_uniques	int	The monthly unique visitors of this publisher.
publisher	str
times_seen	int	The number of times we observed the advertiser's ads on this publisher.

Examples

GET Hide

Kayak's top publishers.
/advertisers/kayak.com/gdn/publishers

GET Hide

Marriott's top publishers.
/advertisers/marriott.com/gdn/publishers

Advertisers / Landing Pages

Get an advertiser's landing pages.

Synopsis

GET /advertisers/{advertiser}/landingpages

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str
first_seen	date	The first time we observed this landing page.
hash	int	The unique ID of the landing page.
last_seen	date	The last time we observed this landing page.
times_seen	int	The number of times we observed the advertiser's ads point to this landing page.
url	int	The URL of the landing page

Examples

GET Hide

Rackspace's top landing pages.
/advertisers/rackspace.com/landingpages

GET Hide

McAfee's newest landing pages.
/advertisers/mcafee.com/landingpages?sort_field=first_seen

Advertisers / Related Advertisers

Get related advertisers based on campaign similarities.

Synopsis

GET /advertisers/{advertiser}/relatedadvertisers

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `similarity`.			similarity
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str
display_publisher_count	int	The number of unique web publishers we've observed for this advertiser.
first_seen	date	The date we first observed observed this advertiser's ads.
gdn_keyword_count	int	The number of unique keywords we've observed for this advertiser on GDN.
gdn_text_ad_count	int	The number of unique GDN text ads.
landing_page_count	int	The number of unique landing pages we've observed for this advertiser.
last_seen	date	The date we last observed observed this advertiser's ads.
rank	int	Global rank of this advertiser.
times_seen	int	The number of times we've observed this advertiser's ads.

Examples

GET Hide

Kayak's top competitors.
/advertisers/kayak.com/relatedadvertisers

GET Hide

Norton's top competitors.
/advertisers/norton.com/relatedadvertisers

Banners / Publishers

Get the publishers we've observed a given banner appear on.

Synopsis

GET /advertisers/{advertiser}/gdn/displayads/{hash}/publishers

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash	The unique id of the ad.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
first_seen	date	The first time we observed the ad on this publisher.
last_seen	date	The last time we observed the ad on this publisher.
monthly_uniques	int	The monthly unique visitors of this publisher.
publisher	str
times_seen	int	The number of times we observed the ad on this publisher.

Examples

GET Hide

Publishers for a Bose creative.
/advertisers/bose.com/gdn/displayads/703a8d5997590a50b42dab31e8f1d1d1/publishers

GET Hide

Publishers for a Porsche Boxster creative.
/advertisers/porsche.com/gdn/displayads/b8e3568b863629215e7b2275dd4c8df9/publishers

GET Hide

Publishers for a Dole Nutrition Institute creative.
/advertisers/dole.com/gdn/displayads/615b25477a2deb4e5efee9df9ca166aa/publishers

Banners / Landing Pages

Get the landing pages we've observed for a given banner.

Synopsis

GET /advertisers/{advertiser}/gdn/displayads/{hash}/destinations

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash	The unique id of the ad.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
destination_url	str	URL the ad pointed to.
first_seen	date	The first time we observed the ad point to this landing page.
last_seen	date	The last time we observed the ad point to this landing page.
times_seen	int	The number of times we observed the ad point to this landing page.

Examples

GET Hide

Landing pages for a diet creative.
/advertisers/beyonddiet.com/gdn/displayads/041aa10ca49743f0e460a283374d7452/destinations

GET Hide

Landing pages for a Gillette body wash creative.
/advertisers/gillette.com/gdn/displayads/e1a32e70db4cdc07c8f2c6ec655020f9/destinations

Text Ads / Publishers

Get the publishers we've observed a given text ad appear on.

Synopsis

GET /advertisers/{advertiser}/gdn/textads/{hash}/publishers

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash	The unique id of the ad.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
avg_position	float	Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
first_seen	date	The first time we observed the ad on this publisher.
last_seen	date	The last time we observed the ad on this publisher.
monthly_uniques	int	The monthly unique visitors of this publisher.
publisher	str
times_seen	int	The number of times we observed the ad on this publisher.

Examples

GET Hide

Top publishers for a Quiznos text ad.
/advertisers/quiznos.com/gdn/textads/cba5ea30870e335f8a25654cbe1e7bc9/publishers

GET Hide

Publishers for a Virgin America text ad.
/advertisers/virginamerica.com/gdn/textads/24524121146a36d61f914b9407955312/publishers

GET Hide

Active publishers for a Ebmunds text ad.
/advertisers/edmunds.com/gdn/textads/b35c7b1c41cce5238ba453561f9080f6/publishers

Text Ads / Landing Pages

Get the landing pages we've observed for a given text ad.

Synopsis

GET /advertisers/{advertiser}/gdn/textads/{hash}/destinations

Required Parameters

Name	Summary
advertiser	The advertiser's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.
hash	The unique id of the ad.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
avg_position	float	Average position of this ad when directed against this landing page.
destination_url	str	URL the ad pointed to.
first_seen	date	The first time we observed the ad point to this landing page.
last_seen	date	The last time we observed the ad point to this landing page.
times_seen	int	The number of times we observed the ad point to this landing page.

Examples

GET Hide

Landing pages for a Dave and Buster's text ad.
/advertisers/daveandbusters.com/gdn/textads/87922ee21c43daa1dad11429a67d6588/destinations

GET Hide

Landing pages for a Smilebox text ad.
/advertisers/smilebox.com/gdn/textads/13fa3d6782940c54ec40bc1540a25520/destinations

Publishers / Overview

Summary information about a publisher.

Synopsis

GET /publishers/{publisher}

Required Parameters

Name	Summary
publisher	The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Response

Path	Type	Summary
gdn_display_ad_count	int	The number of unique banner ads observed on this publisher.
gdn_text_ad_count	int	The number of unique GDN text ads observed on this publisher.
monthly_uniques	int	The number of monthly unique visitors to this publisher.
publisher	str
rank	int	The rank of this publisher.

Examples

GET Hide

Get summary of studentdoctor.net.
/publishers/studentdoctor.net

GET Hide

Get summary of law.com.
/publishers/law.com

GET Hide

Get summary of perezhilton.com.
/publishers/perezhilton.com

Publishers / Advertisers

Advertisers that we have observed run ads on a given publisher.

Synopsis

GET /publishers/{publisher}/gdn/advertisers

Required Parameters

Name	Summary
publisher	The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str
first_seen	date	The first time we observed the advertiser's ads run on the publisher.
last_seen	date	The last time we observed the advertiser's ads run on the publisher.
times_seen	int	The number of times we observed the advertiser's ads run on the publisher.

Examples

GET Hide

Top advertisers on moneynews.com.
/publishers/moneynews.com/gdn/advertisers?page_size=10

GET Hide

Recent advertisers on allnurses.com.
/publishers/allnurses.com/gdn/advertisers?page_size=10&sort_field=last_seen

Publishers / Banners

Get banner ads that have been observed on a given publisher.

Synopsis

GET /publishers/{publisher}/gdn/displayads

Required Parameters

Name	Summary
publisher	The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str	The advertiser.
content_type	str	The file extension, e.g. swf, jpg, gif.
file_size	int	The size of the creative in bytes.
first_seen	date	The first time we observed this ad on this publisher.
format	object	The width, height, and format type of this ad.
hash	str	Unique id of this ad.
last_seen	date	The last time we observed this ad on this publisher.
media_url	str	A URL to download the creative.
times_seen	int	The number of times we have observed this ad on this publisher.

Examples

GET Hide

Top banners that have run on collegedb.com.
/publishers/collegedb.com/gdn/displayads

GET Hide

Recently seen banners on runmyfreecreditreport.com.
/publishers/runmyfreecreditreport.com/gdn/displayads?sort_field=last_seen

GET Hide

Longest running banners on tvsnob.com.
/publishers/tvsnob.com/gdn/displayads?sort_field=first_seen&sort_order=asc

Publishers / Text Ads

Get GDN text ads that have been observed on a given publisher.

Synopsis

GET /publishers/{publisher}/gdn/textads

Required Parameters

Name	Summary
publisher	The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4

Response

Path	Type	Summary
advertiser	str	The advertiser.
avg_position	float	Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
body	str	The subtitle of the ad.
display_url	str	The display url of the ad (visible to the user).
first_seen	date	The first time we observed this ad appear on the publisher.
hash	str	Unique id of this ad.
last_seen	date	The last time we observed this ad appear on the publisher.
times_seen	int	The number of times we have observed this ad appear on the publisher.
title	str	The title of the ad.

Examples

GET Hide

Top text ads observed on kidskonnect.com.
/publishers/kidskonnect.com/gdn/textads?page_size=10

Publishers / Related Publishers

Get related publishers based on advertiser similarities.

Synopsis

GET /publishers/{publisher}/relatedpublishers

Required Parameters

Name	Summary
publisher	The publisher's domain name. Use the root domain name; in particular, do not prefix with "www." or any other subdomain.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `similarity`.			similarity
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
gdn_display_ad_count	int	The number of unique banner ads observed on this publisher.
gdn_text_ad_count	int	The number of unique GDN text ads observed on this publisher.
publisher	str
rank	int	The rank of this publisher.

Examples

GET Hide

Similar publishers to iMotors.com.
/publishers/imotors.com/relatedpublishers

GET Hide

Similar publishers to MySavings.com.
/publishers/mysavings.com/relatedpublishers

Keywords / Overview

Summary information about a contextual keyword.

Synopsis

GET /keywords/{keyword}

Required Parameters

Name	Summary
keyword	A contextual keyword.

Response

Path	Type	Summary
gdn_display_ad_count	int	The number of unique banner ads observed for this keyword.
gdn_text_ad_count	int	The number of unique GDN text ads observed for this keyword.
keyword	str

Examples

GET Hide

Get summary of "best poker sites".
/keywords/best%20poker%20sites

GET Hide

Get summary of "san francisco giants".
/keywords/san%20francisco%20giants

GET Hide

Get summary of "cloud hosting".
/keywords/cloud%20hosting

Keywords / Advertisers

Advertisers we've observed for a given keyword.

Synopsis

GET /keywords/{keyword}/gdn/advertisers

Required Parameters

Name	Summary
keyword	A contextual keyword.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str
first_seen	date	The first time we observed the advertiser's ads target the keyword.
last_seen	date	The last time we observed the advertiser's ads target the keyword.
times_seen	int	The number of times we observed the advertiser's ads target the keyword.

Examples

GET Hide

Top advertisers for "online personals".
/keywords/online%20personals/gdn/advertisers?page_size=20

GET Hide

Recent advertisers for "online degree programs".
/keywords/online%20degree%20programs/gdn/advertisers?page_size=20&sort_field=last_seen

Keywords / Banners

Banner ads we've observed target a given keyword.

Synopsis

GET /keywords/{keyword}/gdn/displayads

Required Parameters

Name	Summary
keyword	A contextual keyword.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str	The advertiser.
content_type	str	The file extension, e.g. swf, jpg, gif.
file_size	int	The size of the creative in bytes.
first_seen	date	The first time we observed this ad targeting this keyword.
format	object	The width, height, and format type of this ad.
hash	str	Unique id of this ad.
last_seen	date	The last time we observed this ad targeting this keyword.
media_url	str	A URL to download the creative.
times_seen	int	The number of times we have observed this ad targeting this keyword.

Examples

GET Hide

Top banners for "30 year mortgage rates".
/keywords/30%20year%20mortgage%20rates/gdn/displayads

GET Hide

Recently seen banners for "cloud hosting".
/keywords/cloud%20hosting/gdn/displayads?sort_field=last_seen

GET Hide

New banners for "buying gold".
/keywords/buying%20gold/gdn/displayads?sort_field=first_seen

Keywords / Text Ads

GDN text ads we've observed target a given keyword.

Synopsis

GET /keywords/{keyword}/gdn/textads

Required Parameters

Name	Summary
keyword	A contextual keyword.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `times_seen`, `avg_position`, `first_seen`, `last_seen`.			times_seen
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
advertiser	str	The advertiser.
avg_position	float	Average position of this ad within ad units. Position is the ad's rank in a text ad block. High positions indicate ads that are next in queue and will show up when a publisher has multiple ad blocks per page, or by using the paging feature in an ad block.
body	str	The subtitle of the ad.
display_url	str	The display url of the ad (visible to the user).
first_seen	date	The first time we observed this ad targeting this keyword.
hash	str	Unique id of this ad.
last_seen	date	The last time we observed this ad targeting this keyword.
times_seen	int	The number of times we have observed this ad targeting this keyword.
title	str	The title of the ad.

Examples

GET Hide

Top text ads for "affordable life insurance".
/keywords/affordable%20life%20insurance/gdn/textads

GET Hide

Top 10 text ads for "pizza delivery".
/keywords/pizza%20delivery/gdn/textads?page_size=10

GET Hide

New text ads for "online savings accounts".
/keywords/online%20savings%20accounts/gdn/textads?sort_field=first_seen

Keywords / Related Keywords

Get related keywords based on advertiser similarities.

Synopsis

GET /keywords/{keyword}/relatedkeywords

Required Parameters

Name	Summary
keyword	A contextual keyword.

Optional Parameters

Name	Summary	Min	Max	Default
offset	Offset the set of results to return. Useful for paging through results.	0		0
page_size	Number of results to return.	1	100	4
sort_field	Sort the results by the field specified. Sortable fields: `similarity`.			similarity
sort_order	Sort the results in the order specified. Sortable directions: `asc`, `desc`.			desc

Response

Path	Type	Summary
gdn_display_ad_count	int	The number of unique banner ads observed for this keyword.
gdn_text_ad_count	int	The number of unique GDN text ads observed for this keyword.
keyword	str

Examples

GET Hide

Similar keywords to "instant payday loans".
/keywords/instant payday loans/relatedkeywords

GET Hide

Similar keywords to "business degrees".
/keywords/business degrees/relatedkeywords