Skip to navigation
API ReferenceHeadcounts

SearchHeadcounts

SearchHeadcounts counts the people matching every condition at each of their accounts (the district of a public school, else the school), by account id, 500 a page by default. It returns no person, so it counts nothing toward the revealed contacts. With beaconIds (and radiusMiles) it counts the people at those beacons’ institutions, or within the radius of them.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Headers

Edulead-TeamstringRequired

Query parameters

conditionsstringOptional<=4096 characters

The conditions, as SearchPeopleRequest’s: beaconIds ({“operator”: “in”, “value”: [“<beacon id>”, …]}) with radiusMiles ({“operator”: “equals”, “value”: 25}) stand for the people at the team’s beacons’ institutions, or within the miles of them.

page_sizeintegerOptional0-500
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=1024 characters

Opaque token from a previous response; empty for the first page.

order_byenumOptional

Sort order: a sortable field name, optionally followed by ” desc”. The allowed values are listed.

Allowed values:

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
next_page_tokenstringOptional

Token for the next page; empty when this is the last page.

total_sizestringOptionalformat: "int64"
How many accounts match, approximate past 40,000.
person_totalstringOptionalformat: "int64"
How many people match over every account.