Count feedback records
Changed onReturns the total number of feedback records matching the given filters. Supports the same query parameters as the list endpoint.
Request
- Base URLhttp://localhost:8080
- URLhttp://localhost:8080/v1/feedback-records/count
- AuthHTTP bearer
Query parameters
Tenant ID (required for isolation). NULL bytes not allowed.
Filter by submission ID to group records belonging to one logical submission. Repeat the parameter to match any of several submissions; the values are OR-ed, and a single occurrence behaves exactly as it always has. Comma-separated values are NOT split. NULL bytes not allowed.
[ "550e8400-e29b-41d4-a716-446655440000" ]
Filter by source type. Repeat the parameter to match any of several source types; the values are OR-ed. NULL bytes not allowed.
[ "survey", "review" ]
Filter by source ID. Repeat the parameter to match any of several sources; the values are OR-ed. NULL bytes not allowed.
[ "survey-123" ]
Filter by field ID — every answer to one question. Repeat the parameter to match any of several fields; the values are OR-ed. NULL bytes not allowed.
[ "q1" ]
Filter by field group ID (for ranking/matrix questions). Repeat the parameter to match any of several groups; the values are OR-ed. NULL bytes not allowed.
[ "feature_priority" ]
Filter by field type. Repeat the parameter to match any of several types; the values are OR-ed. An empty value is ignored rather than rejected, so ?field_type= is the same as omitting the filter.
[ "text", "rating" ]
Filter by the source system's stable option id (e.g. all records for one survey choice). Repeat the parameter to match any of several options; the values are OR-ed. NULL bytes not allowed.
[ "opt_very_satisfied" ]
Filter by end-user identifier — everything one person submitted. Repeat the parameter to match any of several users; the values are OR-ed. NULL bytes not allowed.
[ "user-abc-123" ]
Filter by source display name — the human-readable label stored alongside source_id. Prefer source_id where the records carry one: a name can be edited or translated, while the id is stable. Repeat the parameter to match any of several names; the values are OR-ed. NULL bytes not allowed.
[ "After match survey" ]
Filter by the language the feedback was given in. Repeat the parameter to match any of several languages; the values are OR-ed. NULL bytes not allowed.
[ "en", "ar" ]
Filter by collected_at >= since (ISO 8601 format). Must be between 1970-01-01 and 2080-12-31.
Filter by collected_at <= until (ISO 8601 format). Must be between 1970-01-01 and 2080-12-31.
Filter by created_at >= created_since (ISO 8601, inclusive). created_at is when Hub stored the record; collected_at (see since) is when the feedback was given. They diverge on a historical re-import, so this is the parameter for "what did this import bring in". Must be between 1970-01-01 and 2080-12-31.
Filter by created_at <= created_until (ISO 8601, inclusive). See created_since for how created_at differs from collected_at. Must be between 1970-01-01 and 2080-12-31.
Filter by updated_at >= updated_since (ISO 8601, inclusive). updated_at is stamped on every write to a record — create, update, and every enrichment result (translation, sentiment, emotions) — so this selects records created OR changed since a point: the parameter for incremental extraction. Pair it with sort=updated_at&order=asc. For the next run, use the time the previous run started (its first response's Date header) minus an overlap, not the largest updated_at received. The overlap must outlast the longest write to a record; Hub does not bound that, so a few minutes is a default rather than a guarantee. Permanently deleted records are never returned: periodically list every record, upsert what it returns (which also repairs any change a slow write slipped past the overlap), and remove only local records that were not returned and were created before that listing started (its first response's Date header) minus the overlap. See "Incremental extraction" in the filtering and sorting guide.
Filter by updated_at <= updated_until (ISO 8601, inclusive). See updated_since for what updates updated_at.
Filter by value_number >= value_number_min (inclusive) — e.g. NPS promoters with value_number_min=9. Records whose value_number is NULL (every non-numeric answer) are excluded, so this is never a no-op filter.
Filter by value_number <= value_number_max (inclusive). Paired with value_number_min it selects a band: 9..10 is the NPS promoters, 0..6 the detractors. Records whose value_number is NULL are excluded. Supplying a max below the min is a 400, not an empty result.
Filter by value_date >= value_date_min (ISO 8601, inclusive) — bounds the answer to a date question, not when the feedback was collected. Records whose value_date is NULL are excluded.
Filter by value_date <= value_date_max (ISO 8601, inclusive). Records whose value_date is NULL are excluded.
Filter by sentiment label. Repeat the parameter to match any of several labels (?sentiment=negative&sentiment=very_negative); the values are OR-ed. An empty value is ignored rather than rejected, so ?sentiment= is the same as omitting the filter. Records that have not been enriched carry no sentiment and are therefore never matched — use has_sentiment=false to find them.
[ "negative", "very_negative" ]
Filter by emotion label. Repeat the parameter to match ANY of the listed emotions: a record tagged {joy} and a record tagged {joy, anger} both match ?emotions=joy&emotions=anger. There is no "must carry all of them" form. An empty value is ignored rather than rejected, so ?emotions= is the same as omitting the filter.
[ "anger", "fear" ]
Filter by sentiment_score >= sentiment_score_min (inclusive). The score is continuous where the label is bucketed, so this is the parameter for "the most negative feedback". Records that have not been enriched are excluded.
Filter by sentiment_score <= sentiment_score_max (inclusive). Records that have not been enriched are excluded.
Filter on whether sentiment enrichment has produced a label: true selects records where sentiment IS NOT NULL, false selects those where it IS NULL. Omit for no constraint.
Filter on whether the record carries emotion labels: true selects records where emotions IS NOT NULL, false selects those where it IS NULL. Note that false covers both "not yet classified" and "classified, no emotion detected" — the two are indistinguishable here. Omit for no constraint.
Filter on whether the record has been translated: true selects records where translation_lang_key IS NOT NULL, false selects those where it IS NULL. Omit for no constraint.
Response
OK
Example response
{
"count": 42
}Changes
- info
added the new optional
queryrequest parameterupdated_since - info
added the new optional
queryrequest parameterupdated_until
- info
- breaking
removed the enum value
booleanfrom thequeryrequest parameterfield_type - breaking
removed the enum value
categoricalfrom thequeryrequest parameterfield_type - breaking
removed the enum value
cesfrom thequeryrequest parameterfield_type - breaking
removed the enum value
csatfrom thequeryrequest parameterfield_type - breaking
removed the enum value
datefrom thequeryrequest parameterfield_type - breaking
removed the enum value
npsfrom thequeryrequest parameterfield_type - breaking
removed the enum value
numberfrom thequeryrequest parameterfield_type - breaking
removed the enum value
ratingfrom thequeryrequest parameterfield_type - breaking
removed the enum value
textfrom thequeryrequest parameterfield_type - info
added the new optional
queryrequest parametercreated_since - info
added the new optional
queryrequest parametercreated_until - info
added the new optional
queryrequest parameteremotions - info
added the new optional
queryrequest parameterhas_emotions - info
added the new optional
queryrequest parameterhas_sentiment - info
added the new optional
queryrequest parameterhas_translation - info
added the new optional
queryrequest parameterlanguage - info
added the new optional
queryrequest parametersentiment - info
added the new optional
queryrequest parametersentiment_score_max - info
added the new optional
queryrequest parametersentiment_score_min - info
added the new optional
queryrequest parametersource_name - info
added the new optional
queryrequest parametervalue_date_max - info
added the new optional
queryrequest parametervalue_date_min - info
added the new optional
queryrequest parametervalue_number_max - info
added the new optional
queryrequest parametervalue_number_min - info
removed the pattern
^[^\x00]*$from thequeryrequest parameterfield_group_id - info
removed the pattern
^[^\x00]*$from thequeryrequest parameterfield_id - info
removed the pattern
^[^\x00]*$from thequeryrequest parameterfield_type - info
removed the pattern
^[^\x00]*$from thequeryrequest parametersource_id - info
removed the pattern
^[^\x00]*$from thequeryrequest parametersource_type - info
removed the pattern
^[^\x00]*$from thequeryrequest parametersubmission_id - info
removed the pattern
^[^\x00]*$from thequeryrequest parameteruser_id - info
removed the pattern
^[^\x00]*$from thequeryrequest parametervalue_id - info
for the
queryrequest parameterfield_group_id, the type was generalized fromstringtoarray - info
for the
queryrequest parameterfield_id, the type was generalized fromstringtoarray - info
for the
queryrequest parameterfield_type, the type was generalized fromstringtoarray - info
for the
queryrequest parametersource_id, the type was generalized fromstringtoarray - info
for the
queryrequest parametersource_type, the type was generalized fromstringtoarray - info
for the
queryrequest parametersubmission_id, the type was generalized fromstringtoarray - info
for the
queryrequest parameteruser_id, the type was generalized fromstringtoarray - info
for the
queryrequest parametervalue_id, the type was generalized fromstringtoarray - info
added the non-success response with the status
- breaking