Skip to main content
GET
List the nightly totals for your area

Authorizations

Authorization
string
header
required

A group API key, sent as Authorization: Bearer sw_live_…. Keys from staging and the demo start sw_test_ instead. A group admin creates keys in Settings → Integrations → API keys.

Query Parameters

cursor
string

Opaque. Pass the nextCursor of the previous page, with the same filters, to get the next one. Do not build or parse it.

Required string length: 1 - 512
limit
integer
default:50

Page size, 1 to 200. Defaults to 50.

Required range: 1 <= x <= 200
childId
string<uuid>

Only this group or node below yours. It must share data with you; any other id answers 404.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
metric
enum<string>

Only this figure.

Available options:
member_count,
waiting_count,
net_growth_12m,
young_people_count
day
string<date>

The night to read, YYYY-MM-DD (UTC). Defaults to the latest night your own node was built.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
section
enum<string>
default:all

Which section’s rows. Defaults to all, the totals: one row per node, figure and night. A section (cubs) gives that section’s rows only. any gives every row, the totals and each section. A row’s value already includes everything below it, so to total a set of rows add their ownValue, or read your own node’s value. Adding value across nodes counts a young person twice.

Available options:
all,
squirrels,
beavers,
cubs,
scouts,
explorers,
network,
unassigned,
any

Response

OK

data
object[]
required
nextCursor
string | null
required

Pass as ?cursor= for the next page. Null on the last. Opaque.