Skip to main content
POST
BatchGetPopularity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
entityIds
string[]
Required array length: 1 - 1000 elements
Required string length: 1 - 2048
until
string<date-time>

The window ends at the start of this hour, exclusive. Unset is the current hour, so the window holds closed hours only.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

windowDays
integer

The window's length in days, back from until. Unset is 30.

Required range: x <= 92
pool
enum<string>

The pools to rank in. Unset is SYSTEM.

Available options:
POPULARITY_POOL_UNSPECIFIED,
POPULARITY_POOL_SYSTEM,
POPULARITY_POOL_PLATFORM,
POPULARITY_POOL_WORKSPACE

Response

200 - application/json

Success

entities
EntityPopularity · object[]

One per distinct asked id, in the order each was first asked.

from
string<date-time>

The window read, [from, to).

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

to
string<date-time>

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Example 2: Compute Timestamp from POSIX gettimeofday().

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

Example 4: Compute Timestamp from Java System.currentTimeMillis().

Example 5: Compute Timestamp from Java Instant.now().

Example 6: Compute Timestamp from current time in Python.

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

coveredHours
integer

Hours of the window whose query history was read. An hour that was not read counts nothing either way.

ranksUnavailable
boolean

Set when the ranks could not be computed. The counts are still served, and every rank list is empty.

ranksPending
boolean

Set when the ranks of the default window are not ready for every asked entity yet. The counts are served, and an entity has no ranks until they are.

ranksWindowTo
string<date-time>

The end of the window the ranks were computed for, exclusive, when it differs from to: the ranks of the default window are computed once a day, for the window ending at 00:00 UTC.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"