/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

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 Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

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

Security

  •  janrain-signed
  •  basic-auth

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.