We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

/reports/search/usage

Request

Report number of queries to /document/search for a given site for a given day.

Request

The request object has the following fields when requesting a report for a specific date:

Name

Type

Required

Description

siteId

String

Yes

The site to provide statistics for.

date

String

Yes

The date to provide stats for following the

ISO 8601

extended date format, e.g. "2013-01-27". The date is in UTC.

Response

The response object has the following fields:

Name

Type

Description

siteId

String

The site id for which you requested stats.

usage

Array of object

An array containing a single object for the given date

Usage object:

Name

Type

Description

timestamp

String

The start time (date and time) for the data within this usage object. Returned in UTC according to ISO 8601, i.e. 2013-09-01T00:00:00.000Z.

queries

Number

The number of queries submitted.

zeroHitQueries

Number

The number of queries that returned no hits.

Examples

$ cx.py /reports/search/usage '{"siteId":"922123456789011","date":"2015-08-26"}' {"siteId": "9222387431362186881", "usage": [ {"zeroHitQueries": 90,"queries": 180,"timestamp": "2015-08-26T00:00:00.000Z","indexQueries": {} } ]}

Last updated: