curl --request GET \
--url https://{organization}.rescueconsole.com/api/forms/submissions/facets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/forms/submissions/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/forms/submissions/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"facets": {
"status": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"form_kind": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"form_id": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"decision": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"assignee": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
]
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Count submissions by filter
How many submissions each filter option would give, for the same filters List submissions takes. Each group is counted with its own filter left out and every other filter applied. The status group counts spam too, so you can see how much is there. Narrowed exactly as List submissions is.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/forms/submissions/facets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/forms/submissions/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/forms/submissions/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"facets": {
"status": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"form_kind": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"form_id": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"decision": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"assignee": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
]
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
A kind your key may not read answers 403. What a form is for, which decides the area its submissions belong to and so which keys may read them. adoption_application, foster_application and surrender (a surrender request) are Animals; volunteer (a volunteer sign-up) is Shifts; donor is Fundraising; contact and general are People.
adoption_application, foster_application, volunteer, donor, surrender, contact, general new until somebody reviews it; reviewed; converted once somebody converts it (see Convert a submission); spam, which is kept but left out of the list unless you ask for it. A submission caught by the spam trap on your public form arrives as spam. A submission joined to a person by itself when it arrived stays new, because nobody has reviewed it yet.
new, reviewed, converted, spam approved, rejected, undecided me, nobody