/entity.count

Count the number of records in an entityType that match a query contained in the filter parameter.

Refer to the Registration Error Codes section for details on error codes.

This endpoint uses the following methods:

  • GET


GET

Authentication

This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:

Examples

Example request

Count the number of records that have a value in the birthday field.


curl -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode type_name=user \
    --data-urlencode filter='birthday is not null'\
    https://my-app.janraincapture.com/entity.count
   
      Running this command in Postman

Example Response


{
  "total_count": 15,
  "stat": "ok"
}
   

Example Error Response


{
  "argument_name": "filter",
  "request_id": "r6fsc52quz348mmh",
  "code": 200,
  "error_description": "filter was not valid for the following reason: Unknown attribute (null)",
  "error": "invalid_argument",
  "stat": "error"
}
   

Authorized Clients

  • owner 
  • direct_access 
  • direct_read_access

Query Parameters

Parameter Type Required Description
filter string A query against record fields. If this parameter is not included, all records in the entity are counted. For more information on constructing queries, see entity.find.
 
type_name string Yes entityType where the user record is stored.