GetWordstatReport

Returns a search query statistics report.

Input data

The input data structure in JSON is shown below.

{
   "method": "GetWordstatReport",
   "param": (int)
}

The param parameter is used for specifying the ID of the generated report. You can get the report ID using the GetWordstatReportList method.

Output data

The method returns an array of WordstatReportInfo objects. Each object contains statistics for search queries for a single keyword. The output data structure in JSON is shown below.

{
   "data": [
      {  /* WordstatReportInfo */
         "Phrase": (string),
         "GeoID": [
            (int)
            ...
         ],
         "SearchedWith": [
            {  /* WordstatItem */
               "Phrase": (string),
               "Shows": (int)
            }
            ...
         ],
         "SearchedAlso": [
            {  /* WordstatItem */
               "Phrase": (string),
               "Shows": (int)
            }
            ...
         ]
      }
      ...
   ]
}

Parameters are described below.

^Parameter	^Description
_{WordstatReportInfo object}
`Phrase`	The keyword that statistics are given for (specified when generating the report).
`GeoID`	Array with region IDs (specified when generating the report).
`SearchedWith`	Statistics for search queries that match the keyword.
`SearchedAlso`	Statistics for other search queries that consumers made when searching for a keyword from the `SearchedWith` array.
_{WordstatItem object}
`Phrase`	In the `SearchedWith` array: the search query that matches the keyword (all the words in the keyword are included in the search query, and the negative keywords are not in the search query). In the `SearchedAlso` array: a search query that consumers also made.
`Shows`	Number of search queries over the last month.

GetWordstatReport

Input data

Output data

Was the article helpful?