Skip to main content
POST
Public URL Statistics (password unlock)

Authorizations

Authorization
string
header
required

API key authentication. Pass your key as: Bearer spoo_<your_key>

Path Parameters

short_code
string
required

Query Parameters

start_date
string | null

Range start (ISO 8601). Defaults to 7 days before end_date.

Maximum string length: 50
Example:

"2025-01-01T00:00:00Z"

end_date
string | null

Range end (ISO 8601). Defaults to now.

Maximum string length: 50
Example:

"2025-12-31T23:59:59Z"

timezone
string
default:UTC

IANA timezone for time bucketing and formatting.

Maximum string length: 50
Examples:

"UTC"

"America/New_York"

Body

application/json

Optional JSON body carrying the stats-page password.

password
string | null

Password for a password-protected link's stats.

Maximum string length: 200

Response

Successful Response

Response body for GET|POST /api/v1/public/stats/{short_code}.

generation
enum<string>
required
Available options:
v1,
v2

Public facts about the link shown above the charts.

stats
Stats · object
required

The modern stats wire shape (same as GET /api/v1/stats): summary, metrics keyed '{metric}by{dimension}', time_range, time_bucket_info, computed_metrics. v1 links carry a 'clicks_by_bots' dimension and no 'city'/'device'; v2 the reverse.