WAwavix
Link shortener

List short link metrics

Changed on

Returns per-click metrics for short links, including device, location, and campaign attribution, within the requested date range.

get/v1/short-links/metrics

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/short-links/metrics
  • Auth
    HTTP bearer

Query parameters

fromstring date required
Example:2023-05-01

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

tostring date required
Example:2023-05-31

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

phonestring
Example:1872025555

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

utm_campaignstring
Example:summer

Filters metrics by utm_campaign name.

pageinteger
Example:1

Page number to retrieve. Default 1.

per_pageinteger
Example:25

Number of records to return per page. Default 25.

Response

Returns a paginated list of short link metrics.

Example response

{
  "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-19 18:23:42",
      "link_hash": "hd82Jhs21",
      "user_id": 100017
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Changes

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 33be77905120Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API