Return a Count of Items

By default, a count of items returned in a result set is not included. To include a count of items returned in a result set, include the ?count=true query parameter in your query.

For example, the following query will return all Indicators, and a count of how many Indicators were returned will be included:

GET /v3/indicators?count=true

JSON Response

{
    "data": [
        {
            "id": 18,
            "type": "EmailAddress",
            "ownerName": "Demo Organization",
            "dateAdded": "2021-10-26T16:26:19Z",
            "webLink": "/auth/indicators/details/emailaddress.xhtml?emailaddress=verybadguy%40bad.com",
            "lastModified": "2021-11-08T18:25:48Z",
            "description": "Sample Email Address Indicator created via API",
            "summary": "[email protected]",
            "privateFlag": false,
            "active": true,
            "activeLocked": false,
            "address": "[email protected]"
        },
        {
            "id": 15,
            "type": "EmailAddress",
            "ownerName": "Demo Organization",
            "dateAdded": "2021-10-26T13:08:37Z",
            "webLink": "/auth/indicators/details/emailaddress.xhtml?emailaddress=ultrabadguy%40bad.com",
            "lastModified": "2021-11-02T15:00:32Z",
            "description": "The worst kind of email address for a bad guy to use.",
            "summary": "[email protected]",
            "privateFlag": false,
            "active": true,
            "activeLocked": false,
            "address": "[email protected]"
        },
        {...}
    ],
    "count": 20,
    "status": "Success"
}

Note

If the ?count= query parameter is set to false, or if the resultStart query parameter is set to a value greater than 0, a count of items returned in a result set will not be included.