Report a conversion goal's resultsMenu

Report a conversion goal's results

GET/v1/conversion-goals/{id}/metrics

Requires an API key with the conversion-goals:read scope. About keys and scopes

Works with integration, agent and partner keys.

Conversions, the contacts who converted out of those sent to, and revenue when the goal has a valueProperty. Revenue sums values in the goal currency only: a value counts when it is a non-negative number or numeric string ("49.90", no thousands separators) up to 999,999,999,999.99. conversionsWithoutValue counts the conversions that carried none — the property missing or unusable, a negative (refunds are not revenue), or an event naming another currency — so it explains a gap between conversions and revenue. reachedContacts counts only sends a conversion could be credited to: from one attribution window before countedFrom. conversionRate is null until there is such a send. The totals are all time, every conversion the goal has counted since countedFrom (each under the attribution window in force when it was counted; see windowChangedAt); history covers the report window (from inclusive to to exclusive, the last 30 days by default) day by day in the workspace timezone.

Path parameters

idstringrequired

The conversion goal's id.

uuid

Query parameters

fromstringoptional: Start of the window, inclusive: a date-time, or a date meaning the start of that day in the workspace timezone. Give with to; omit both for the last 30 days.
tostringoptional: End of the window, exclusive, in the same forms. To include a whole last day, pass the day after it: from=2026-10-01&to=2026-10-08 covers 1 to 7 October. No later than the end of today; a window touches at most 366 days. Give with from.

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Returns

Returns 200 OK with a ConversionGoalMetrics in data. Otherwise returns an error; Errors lists every code and which to retry.

conversionGoalIdstringrequired

uuid

conversionsintegerrequired

All time: every event the goal counted, from countedFrom; one contact can convert more than once.

min 0

convertedContactsintegerrequired

All time: the contacts behind conversions.

min 0

reachedContactsintegerrequired

All time: contacts sent to that a conversion could be credited to, from one attribution window before countedFrom.

min 0

conversionRatenumber | nullrequired

All time: convertedContacts over reachedContacts; null before there is such a send.

min 0

revenueobject | nullrequired

All time: the value property's sum, in the goal currency; null when the goal has no valueProperty.

2 child attributes

currencystring | nullrequired: The currency, an ISO 4217 code; null when none was named.
valuenumberrequired: The amount in that currency.

conversionsWithoutValueinteger | nullrequired

All time: conversions counted without a value (the property missing, not a non-negative number, too large, or the event naming another currency); null when the goal has no valueProperty.

min 0

historyobjectrequired

The conversions in the report window.

4 child attributes

fromstringrequired

Start of the window, inclusive.

date-time

tostringrequired

End of the window, exclusive.

date-time

timezonestringrequired

The workspace timezone the days are in.

seriesobject[]required

One entry per day in the window, by when each conversion happened.

3 child attributes

startsAtstringrequired

When this day starts in timezone, given as an instant.

date-time

conversionsintegerrequired

min 0

revenueobject | nullrequired

The day's revenue; null when the goal has no valueProperty.

2 child attributes

currencystring | nullrequired: The currency, an ISO 4217 code; null when none was named.
valuenumberrequired: The amount in that currency.

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

const response = await fetch('https://api.kirora.io/v1/conversion-goals/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/metrics', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Kirora API ${response.status}: ${await response.text()}`);
const { data } = await response.json();

import os

import requests

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

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/conversion-goals/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/metrics", 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()
	if res.StatusCode >= 300 {
		msg, _ := io.ReadAll(res.Body)
		panic(fmt.Sprintf("Kirora API %d: %s", res.StatusCode, msg))
	}

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

using System.Net.Http.Headers;
using System.Text.Json;

using var http = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.kirora.io/v1/conversion-goals/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/metrics");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("KIRORA_API_KEY"));

using var response = await http.SendAsync(request);
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"Kirora API {(int)response.StatusCode}: {await response.Content.ReadAsStringAsync()}");

using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var data = document.RootElement.GetProperty("data");

Response · 200

{
  "data": {
    "conversionGoalId": "0192f3d0-7a1b-7c2d-8e3f-4a5b6c7d8e9f",
    "conversions": 41,
    "convertedContacts": 38,
    "reachedContacts": 1180,
    "conversionRate": 0.03220338983050847,
    "revenue": {
      "currency": "USD",
      "value": 2050
    },
    "conversionsWithoutValue": 0,
    "history": {
      "from": "2026-09-26T00:00:00.000Z",
      "to": "2026-09-28T00:00:00.000Z",
      "timezone": "UTC",
      "series": [
        {
          "startsAt": "2026-09-26T00:00:00.000Z",
          "conversions": 3,
          "revenue": {
            "currency": "USD",
            "value": 150
          }
        },
        {
          "startsAt": "2026-09-27T00:00:00.000Z",
          "conversions": 2,
          "revenue": {
            "currency": "USD",
            "value": 100
          }
        }
      ]
    }
  }
}