Get metrics for short links

curl --request GET \
  --url 'https://api.wavix.com/v1/short-links/metrics?appid='

{
  "metrics": [
    {
      "latitude": 59.3247,
      "longitude": 18.056,
      "operating_system": "Mac OS X 10.15",
      "browser": "Firefox",
      "language": "English",
      "phone": "12762025555",
      "utm_campaign": "summer",
      "created_at": "2023-07-19T18:23:42.120Z",
      "link_hash": "hd82Jhs21",
      "user_id": 100017
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

GET

short-links

metrics

Get metrics for short links

curl --request GET \
  --url 'https://api.wavix.com/v1/short-links/metrics?appid='

{
  "metrics": [
    {
      "latitude": 59.3247,
      "longitude": 18.056,
      "operating_system": "Mac OS X 10.15",
      "browser": "Firefox",
      "language": "English",
      "phone": "12762025555",
      "utm_campaign": "summer",
      "created_at": "2023-07-19T18:23:42.120Z",
      "link_hash": "hd82Jhs21",
      "user_id": 100017
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Authorizations

appid

string

query

required

An API key to authorize your request

Query Parameters

from

string

required

Start date of your search time range, in yyyy-mm-dd format.

Example:

"2023-05-01T00:00:00.000Z"

string

required

End date of your search time range, in yyyy-mm-dd format.

Example:

"2023-05-31T00:00:00.000Z"

phone

string

Filter results by the phone number associated with the short links.

Example:

"1872025555"

utm_campaign

string

Filter results by the UTM campaign parameter. You can use this parameter to group the tracking insights by campaign.

Example:

"summer"

page

integer<int32>

The page number

Example:

1

per_page

integer<int32>

The number of records per page

Example:

25

Response

Short link metrics

metrics

ShortlinkMetricsItem · object[]

required

Short link metrics that match the search criteria

Show child attributes

metrics.latitude

number | null

required

The latitude of the location associated to the IP address used when the short link was opened

Example:

59.3247

metrics.longitude

number | null

required

The longitude of the location associated to the IP address used when the short link was opened

Example:

18.056

metrics.operating_system

string

required

The operating system used by the user when the short link was opened

Example:

"Mac OS X 10.15"

metrics.browser

string

required

The browser used by the user to open the short link

Example:

"Firefox"

metrics.language

string

required

The language preference of the user browser use to open the short link

Example:

"English"

metrics.phone

string

required

The phone number associated with the metric

Example:

"12762025555"

metrics.utm_campaign

string

required

The UTM campaign parameter associated with the metric

Example:

"summer"

metrics.created_at

string

required

The timestamp indicating when a user opened the short link

Example:

"2023-07-19T18:23:42.120Z"

metrics.link_hash

string

required

Has of the short link

Example:

"hd82Jhs21"

metrics.user_id

integer

required

User id

Example:

100017

pagination

Pagination · object

required

Show child attributes

pagination.current_page

integer<int32>

required

Current page number

Example:

2

pagination.per_page

integer<int32>

required

Number of records per page

Example:

25

pagination.total

integer<int32>

required

Total number of records

Example:

101

pagination.total_pages

integer<int32>

required

Total number of pages

Example:

5

Create a short link

Create a new 2FA Verification

Using the APIs

API reference

Get metrics for short links

Authorizations

Query Parameters

Response