Skip to main content
GET
List short link metrics

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

from
string<date>
required

Start of the date range to query, in YYYY-MM-DD format. Inclusive.

Example:

"2023-05-01"

to
string<date>
required

End of the date range to query, in YYYY-MM-DD format. Inclusive.

Example:

"2023-05-31"

phone
string

Filters metrics by the phone number associated with the click, in E.164 format.

Example:

"1872025555"

utm_campaign
string

Filters metrics by utm_campaign name.

Example:

"summer"

page
integer<int32>

Page number to retrieve. Default 1.

Example:

1

per_page
integer<int32>

Number of records to return per page. Default 25.

Example:

25

Response

Returns a paginated list of short link metrics.

metrics
ShortLinkMetricsItem · object[]
required

List of short link metrics matching search criteria.

pagination
Pagination · object
required