• 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. Currently, HTTP GET is the only supported verb, and 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

Examples

GET Hide
Check your API key.
/echo

Companies / Directory

Directory of companies.

Synopsis

GET /companies

Optional Parameters

Response

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

Response

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

Response

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

Response

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

Response

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

Optional Parameters

Response

Examples

GET Hide
Rankings for Starbucks.
/appstore/apps/331177714/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

Optional Parameters

Response

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

iOS Apps / SDKs

SDKs installed in a given app.

Synopsis

GET /appstore/apps/{app_id}/sdks

Required Parameters

Optional Parameters

Response

Examples

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

iOS Apps / Configs

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

Synopsis

GET /appstore/apps/{app_id}/configs

Required Parameters

Response

Examples

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

iOS Apps / Versions

Releases of an app.

Synopsis

GET /appstore/apps/{app_id}/versions

Required Parameters

Optional Parameters

Response

Examples

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

iOS Apps / In-App Purchases

In-App purchases offered by this app.

Synopsis

GET /appstore/apps/{app_id}/iaps

Required Parameters

Optional Parameters

Response

Examples

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

iOS Apps / Reviews

User reviews of a given app.

Synopsis

GET /appstore/apps/{app_id}/reviews

Required Parameters

Optional Parameters

Response

Examples

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

iOS Apps / Downloads

Download trends for a given app.

Synopsis

GET /appstore/apps/{app_id}/downloads

Required Parameters

Response

Examples

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

iOS Apps / Revenue

Revenue trends for a given app.

Synopsis

GET /appstore/apps/{app_id}/revenue

Required Parameters

Response

Examples

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

iOS Developers / Apps

Apps published by a developer

Synopsis

GET /appstore/developers/{developer_id}/apps

Required Parameters

Optional Parameters

Response

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

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

Optional Parameters

Response

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

Response

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

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Response

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

Play Store Apps / Directory

Directory of Play Store (Android) apps.

Synopsis

GET /playstore/apps

Optional Parameters

Response

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

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

Examples

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

Play Store Developers / Apps

Apps published by a developer

Synopsis

GET /playstore/developers/{developer_id}/apps

Required Parameters

Optional Parameters

Response

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

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

Optional Parameters

Response

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

Response

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

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Response

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

Response

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

Response

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

Response

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

Optional Parameters

Response

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

Response

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

Optional Parameters

Response

Examples

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

Advertisers / Overview

Summary information about an advertiser.

Synopsis

GET /advertisers/{advertiser}

Required Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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

Optional Parameters

Response

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