Count submissions
Counts the submissions matching the filters instead of returning them, so you can see the size of an answer before you page through it. Takes the same filters as the list.
Pass group_by to count by day, week, month, country, spam, read or a submitted field, and the largest 20 groups come back with the rest in other. A count that does not finish in time returns what it reached with exact: false; narrow the date range for an exact one.
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))
}HttpResponse<String> response = Unirest.get("https://api.formcarry.com/v1/forms/{form_id}/submissions/summary")
.header("Authorization", "Bearer <token>")
.asString();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_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The form's id, as shown in the dashboard and in the form's endpoint URL
Query Parameters
Which submissions to include: the inbox (default), spam, or both.
inbox, spam, all Only submissions that have (true) or have not (false) been read in the dashboard.
true, false Only submissions with (true) or without (false) uploaded files.
true, false Only submissions created at or after this time (RFC 3339, or milliseconds since the epoch).
Only submissions created before this time (RFC 3339, or milliseconds since the epoch).
Only submissions sent from this country. Two-letter uppercase code. For several, separate them with commas. Max 20.
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.
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
Submissions matching the filters.
428
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.
What the counts are grouped by, or null for the total alone.
"country"
Largest first, up to 20.
Show child attributes
Show child attributes
Submissions in groups outside the 20 returned.
12
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.
Was this page helpful?
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))
}HttpResponse<String> response = Unirest.get("https://api.formcarry.com/v1/forms/{form_id}/submissions/summary")
.header("Authorization", "Bearer <token>")
.asString();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