Count submissions - formcarry

GET

/

v1

/

forms

/

{form_id}

/

submissions

/

summary

Count submissions

curl --request GET \
  --url https://api.formcarry.com/v1/forms/{form_id}/submissions/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.formcarry.com/v1/forms/{form_id}/submissions/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.formcarry.com/v1/forms/{form_id}/submissions/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.formcarry.com/v1/forms/{form_id}/submissions/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.formcarry.com/v1/forms/{form_id}/submissions/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.formcarry.com/v1/forms/{form_id}/submissions/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "total": 428,
  "exact": true,
  "group_by": "country",
  "buckets": [
    {
      "key": "DE",
      "count": 120
    }
  ],
  "other": 12,
  "truncated": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

form_id

string

required

The form's id, as shown in the dashboard and in the form's endpoint URL

Query Parameters

status

enum<string>

default:inbox

Which submissions to include: the inbox (default), spam, or both.

Available options:

inbox,

spam,

all

read

enum<string>

Only submissions that have (true) or have not (false) been read in the dashboard.

Available options:

true,

false

has_attachments

enum<string>

Only submissions with (true) or without (false) uploaded files.

Available options:

true,

false

created_after

string

Only submissions created at or after this time (RFC 3339, or milliseconds since the epoch).

created_before

string

Only submissions created before this time (RFC 3339, or milliseconds since the epoch).

country

string

Only submissions sent from this country. Two-letter uppercase code. For several, separate them with commas. Max 20.

q

string

Only submissions where any field contains this text, matched literally and without case. 2 to 512 characters. On some forms a field that only appeared in very old submissions may be missed, so name that field with a field filter.

group_by

string

Count by this instead of returning one total: day, week, month, country, spam, read, or field: for a submitted field. Leave it out for the total alone.

Response

total

number

required

Submissions matching the filters.

Example:

428

exact

boolean

required

False when the count did not finish in time, so total and the counts are a floor rather than the whole set. Narrow the date range for an exact answer.

group_by

string | null

required

What the counts are grouped by, or null for the total alone.

Example:

"country"

buckets

object[]

required

Largest first, up to 20.

Show child attributes

other

number

required

Submissions in groups outside the 20 returned.

Example:

12

truncated

boolean

required

True when group_by passed 10,000 distinct values, so some are missing from buckets though their submissions still count in total and other. Always false without group_by.

⌘I

Count submissions

curl --request GET \
  --url https://api.formcarry.com/v1/forms/{form_id}/submissions/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.formcarry.com/v1/forms/{form_id}/submissions/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.formcarry.com/v1/forms/{form_id}/submissions/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.formcarry.com/v1/forms/{form_id}/submissions/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.formcarry.com/v1/forms/{form_id}/submissions/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.formcarry.com/v1/forms/{form_id}/submissions/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "total": 428,
  "exact": true,
  "group_by": "country",
  "buckets": [
    {
      "key": "DE",
      "count": 120
    }
  ],
  "other": 12,
  "truncated": true
}