Web Property List

GET URL

GET v3/accounts/{accountId}/web-properties

Description

Returns a list of all web properties (and their comparison web properties) tracked by a given account. Also get API links to other related information. Example:

[{
    "isActive": true,
    "webPropertyId": "3283746",
    "name": "yoyodyne.com",
    "trackedSearchList": "https://api.conductor.com/v3/accounts/13414534/web-properties/3283746/tracked-searches",
    "rankSourceInfo":
    [{
        "rankSourceId": "1",
        "comparisonWebProperties": 
        [{
            "webPropertyId": "14520678",
            "name": "hypergolicenterprises.com",
            "label": "Competitor"
        }],
        "reports": 
        {
            "CURRENT": 
            {
                "timePeriodId": "273",
                "startDate": "2015-06-12T00:00:00Z",
                "endDate": "2015-06-18T23:59:59Z",
                "webPropertyRankReport": "https://api.conductor.com/v3/13414534/web-properties/3283746/rank-sources/1/tp/CURRENT/serp-items",
                "webPropertySearchVolumeReport": "https://api.conductor.com/v3/13414534/web-properties/3283746/rank-sources/1/tp/CURRENT/search-volumes"
            }
        }
    }] 
}]

Parameters

accountId

The numeric identifier of a Conductor account. You can find this after logging into a Conductor account in the URL. Just  go to Insight Stream—the numerical string in the URL represents the Account ID. For example:

https://app.conductor.com/5197/insight-stream

Required?: Yes
Type: String

Response

The response is a JSON-encoded array containing objects representing the account's configured client web properties, each having the attributes:

isActive

Indicates whether the web property is currently active in Conductor or not.

rankSourceInfo

This is an array of objects that describe the web property’s configuration and data for each of its associated search engines. The combination of search engine provider, location, and language are considered a single "rank source". For example, the following are four different rank sources:

  • Google (US / English)
  • Google (US / Spanish)
  • Google (Canada / English)
  • Google (Canada / French)

Each of these rank sources have the following attributes:

reports

A collection of objects representing the time periods for which platform reports about this rank source are available. If the web property is active then the most up-to-date information can always be found under the “CURRENT” object returned here :

 

  • startDate: The (inclusive) beginning of this reporting period. All date values are in YYYYMMDD format.
  • endDate: The (inclusive) end of this reporting period. All date values are in YYYYMMDD format.
  • webPropertySearchVolumeReport: The API URL of this web property and rank source combination’s Client Web Property Search Vol. Report endpoint for this reporting period.
  • webPropertyRank Report: The API URL of this web property and rank source combination’s Client Web Property Rank Report for this reporting period.
  • timePeriodId: This reporting period’s numeric identifier string. Time period IDs can be inferred from URLs in the Conductor platform. For example, in the example URL below for the Keywords report, the report indicates that the time periods 686 and 687 are being compared. New time periods always take the next subsequent integer from the current time period (i.e. time period 687 is followed by time period 688, 688 by 689, and so on).

https://app.conductor.com/5197/keywords?rankType=TRUE_RANK&compareTP=686&reportTP=687&...

comparisonWebProperties

An collection of objects representing any comparison web properties configured for this client web property and rank source, each having descriptive information:

  • webPropertyId: The comparison web property’s numeric identifier string. This also appears in the webPropertyId column of the Client Web Property Rank Report and appears in Conductor platform URLs that include comparison web properties. For example, in Rank Comparisons, the numeric string listed after webPropertyIds URL parameter represent the web property IDs of each compared web property (the corresponding comparison web property names appear in the following URL parameter:

https://app.conductor.com/...&webPropertyIds=99416%2C117817&domains=amazon.com%2Cyoutube.com

  • name: The name associated in the platform with the comparison web property.
  • label: The comparison web property’s label, or "null" if none is configured.

rankSourceId

The numeric identifier for the rank source. The combination of search engine provider, location, and language are considered a single "rank source". For example, the following are four different rank sources with four different rankSourceIds:

  • Google (US / English)
  • Google (US / Spanish)
  • Google (Canada / English)
  • Google (Canada / French)

This value also appears in the Rank Source List endpoint.

webPropertyId

The web property’s numeric identifier string. This also appears in the webPropertyId column of the Client Web Property Rank Report and appears in Conductor platform URLs that are specific to web properties. For example, in Explorer, the second numeric string represents the web property ID:

https://app.conductor.com/5197/web-properties/15350/rank-sources/1/explorer

trackedSearchList

The API URL of this web property’s list of tracked keywords, found in the TrackedSearchList endpoint.

name

The name associated in the platform with the web property.

 

Try this endpoint with the interactive documentation

version 56 as of 4 months ago by Patrick Morgan