Forms

Retrieve form statistics

GET/v1/forms/{id}/stats

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

Submission counters for one form.

Path parameters

idstringrequired: uuid

Returns

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

totalintegerrequired

All submissions.

min 0 · max 9007199254740991

createdintegerrequired

Submissions that created a contact.

min 0 · max 9007199254740991

updatedintegerrequired

Submissions that updated an existing contact.

min 0 · max 9007199254740991

honeypotintegerrequired

Submissions caught as bots by the honeypot field.

min 0 · max 9007199254740991

pendingintegerrequired

Double opt-in submissions still waiting for their confirmation link.

min 0 · max 9007199254740991

viewsintegerrequired

Loads of the public form.

min 0 · max 9007199254740991

submitRatenumber | nullrequired

Submissions, less honeypot catches, per view; null before the first view.

min 0

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

const response = await fetch('https://api.kirora.io/v1/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats', {
  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/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats",
    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/forms/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats", 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": {
    "total": 0,
    "created": 0,
    "updated": 0,
    "honeypot": 0,
    "pending": 0,
    "views": 0,
    "submitRate": 0
  }
}

Example values are generated from the schema.