Searchlight API Interactive Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• Searchlight API v2.0 End Points

  • List Methods
  • Expand Methods

  • GET Accounts List v2/accounts

    Returns a list of all accounts available to the authenticated user.

  • GET Domains List v2/accounts/:account_id/domains

    List the domains within the account that are avaialable to the authenticated user.

    Parameter	Value	Type	Description
    :account_id		string

  • GET Keywords List v2/accounts/:account_id/domains/:domain_id/keywords

    Returns a list of all the active keywords in the specified domain.

    Parameter	Value	Type	Description
    :account_id		string
    :domain_id		string

  • GET Rank Updates List v2/accounts/:account_id/domains/:domain_id/rankupdates

    Returns the publish periods which can be used in the asof parameter to access historical information.

    Parameter	Value	Type	Description
    :account_id		string
    :domain_id		string

  • GET Latest Rank Updates v2/accounts/:account_id/domains/:domain_id/rankupdates/latest

    Returns the latest publish period for a provided account and domain.

    Parameter	Value	Type	Description
    :account_id		string
    :domain_id		string

  • GET Keyword Details v2/accounts/:account_id/domains/:domain_id/keywords/:keyword_id

    Returns PLP, Prime, Status, Date Created and URI for a provided keyword.

    Parameter	Value	Type	Description
    :account_id		string
    :domain_id		string
    :keyword_id		string

  • GET Categories List v2/accounts/:account_id/categories

    Returns a list of all the categories for a given account.

    Parameter	Value	Type	Description
    :account_id		string

  • GET Engine Details v2/engines/:engine_id

    Returns name, country, language, url and uri for a given engine.

    Parameter	Value	Type	Description
    :engine_id		string

  • GET Keyword Ranks List v2/accounts/:account_id/domains/:domain_id/keywords/ranks

    This resource method will return ranking data for all keywords under the domain. Depending on the size of the response document the results may be paginated. If the response document is paginated then the value of the complete field in the JSON document will be false and the value of the next field will contain a URI to the next page of the result set. The order of individual keywords in the result set will always be consistent in order to allow for pagination.

    Parameter	Value	Type	Description
    :account_id		string
    :domain_id		string

  • GET Competitor Keyword Ranks List v2/accounts/:account_id/domains/:domain_id/keywords/:keyword_id/competitorranks

    This resource method will return ranking data for all keywords under the domain. Depending on the size of the response document the results may be paginated. If the response document is paginated then the value of the complete field in the JSON document will be false and the value of the next field will contain a URI to the next page of the result set. The order of individual keywords in the result set will always be consistent in order to allow for pagination.

    Parameter	Value	Type	Description
    :account_id		string
    :domain_id		string
    :keyword_id		string

• Searchlight API v3.0 End Points

  • List Methods
  • Expand Methods

  • GET Account List v3/accounts

    Lists the accounts available to the authenticated user.

  • GET Web Property List v3/accounts/:accountId/web-properties

    Lists the web properties within the account that are available to the authenticated user, along with their configured comparison domains.

    Parameter	Value	Type	Description
    :accountId		string	the account id

  • GET Category List v3/accounts/:accountId/categories

    Lists the categories configured for a particular account.

    Parameter	Value	Type	Description
    :accountId		string	the account id

  • GET Tracked Search List v3/accounts/:accountId/web-properties/:webPropertyId/tracked-searches

    Lists the tracked searches configured for a particular web property.

    Parameter	Value	Type	Description
    :accountId		string	the account id
    :webPropertyId		string	the web property id

  • GET Client Web Property Rank Report v3/:accountId/web-properties/:webPropertyId/rank-sources/:rankSourceId/tp/:timePeriodId/serp-items

    Provides a report of search items of interest seen for all tracked searches within a client web property

    Parameter	Value	Type	Description
    :accountId		string	the account id
    :webPropertyId		string	the web property id
    :rankSourceId		string	the rank source id
    :timePeriodId		string	the time period id

  • GET Client Web Property Search Vol. Report v3/:accountId/web-properties/:webPropertyId/rank-sources/:rankSourceId/tp/:timePeriodId/search-volumes

    Provides a report of search volumes for all tracked searches within a client web property

    Parameter	Value	Type	Description
    :accountId		string	the account id
    :webPropertyId		string	the web property id
    :rankSourceId		string	the rank source id
    :timePeriodId		string	the time period id

  • GET Rank Source List v3/rank-sources

    Lists all rank sources, with descriptive information as needed to interpret the Web Properties and Tracked Searches results.

  • GET Location List v3/locations

    Lists all locations with descriptive information as needed to interpret the Tracked Searches results.

  • GET Device List v3/devices

    Lists all devices with descriptive information as needed to interpret the Tracked Searches results.