Web Properties

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

Returns a list of all client web properties for a given account, along with per-rank-source comparisons and API links to subsidiary 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"
            }
        }
    }] 
}]

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

webPropertyId The client web property’s opaque identifier string, as appears in the webPropertyId column of the Client Web Property Rank Report.
name The mechanism for identifying pages in a web property. This currently is a domain name but may be extended in the future to cover possibilities like subfolders.
isActive An indicator of whether the web property is currently active or not.
rankSourceInfo  An array of objects describing this web property’s per-rank-source configuration and data, each having the attributes:
rankSourceId The rank source’s opaque identifier string.
comparisonWebProperties An array 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 opaque identifier string, as may appear in the web_property column of the Client Web Property Rank Report.
name The mechanism for identifying pages in this comparison web property. This currently is a domain name but may be extended in the future to cover possibilities like subfolders.
label The comparison web property’s label, or null if none is configured.
reports A collection of objects representing time periods for which reports pertaining to this web property and 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.
startDate The (inclusive) beginning of this reporting period. All date values are in ISO8601 format.
endDate The (inclusive) end of this reporting period. All date values are in ISO8601 format.
webPropertySearch
VolumeReport		 The API URL of this web property/rank source combination’s Client Web Property Search Volume Report for this reporting period.
webPropertyRank
Report		 The API URL of this web property/rank source combination’s Client Web Property Rank Report for this reporting period.
timePeriodId This reporting period’s opaque identifier string.
trackedSearchList  The API URL of this web property’s Tracked Search List


Try this endpoint with the interactive documentation.

version 24 as of 4 years ago by pmorgan