Campaigns

List a campaign's most clicked links

GET/v1/campaigns/{id}/links

Requires an API key with the campaigns:read scope. About keys and scopes

The links in a campaign email ranked by clicks, up to 50. uniqueClicks counts recipients who clicked the link at least once; clicks counts every click. A link is reported without its query string or fragment, so a personalised link counts as one. One recipient can click several links, so the unique clicks here can add up to more than the campaign's clicked.

Path parameters

idstringrequired: uuid

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

campaignIdstringrequired

uuid

linksobject[]required

Links ranked by clicks, most clicked first.

at most 50 items

3 child attributes

urlstringrequired

The destination without its query string or fragment.

clicksintegerrequired

Every click on the link.

min 0 · max 9007199254740991

uniqueClicksintegerrequired

Recipients who clicked the link at least once.

min 0 · max 9007199254740991

curl https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/links \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/links', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/links",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/links", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "campaignId": "018f2a4e-6b1c-7d3e-9f40-3478765e5a6b",
    "links": [
      {
        "url": "https://example.com/webhooks/kirora",
        "clicks": 0,
        "uniqueClicks": 0
      }
    ]
  }
}

Example values are generated from the schema.