Report common queries from /document/search for a given site on a given date. The queries are counted based on the value in "logQuery" as documented in /document/search.
Request
The request object has the following fields when requesting a report for a specific date:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
The site to provide statistics for. |
|
|
String |
Yes |
The date to provide stats for following the ISO 8601 extended date format, e.g. "2013-01-27". The date is always interpreted as UTC. |
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The site you requested stats for. |
|
|
Array of Object |
Most commonly searched terms for the site for the requested date. See table below for more details. |
|
|
Array of Object |
Monst commonly searched terms that did not return any results for the site for the requested date. See table below for more details. |
Both the matchingQueries and the zeroHitQueries field will return an array of objects where each entry represents one query along with its stats for the requested date. Each entry contains the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The value from logQuery (see doc in /document/search ) |
|
|
Number |
How many times the query was searched for in the requested date. |
Example
$ cx.py /reports/search '{"siteId":"922123456789011","date":"2015-08-26"}'
{
"siteId": "922123456789011",
"matchingQueries": [
{
"query": "heat wave in Australia",
"count": 200
},
"query": "blizzard in Norway",
"count": 100
}
],
"zeroHitQueries": [
{
"query": "heat wave in Norway",
"count": 200
},
{
"query": "blizzard in Australia",
"count": 100
}
]
}