Chilkat Online Tools

Ruby / Salesforce Platform APIs / Record Count

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("sObjects","Account,Contact,Lead")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/limits/recordCount",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "sObjects": [
#     {
#       "count": 12,
#       "name": "Account"
#     },
#     {
#       "count": 20,
#       "name": "Contact"
#     },
#     {
#       "count": 22,
#       "name": "Lead"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i = 0
count_i = jResp.SizeOfArray("sObjects")
while i < count_i
    jResp.put_I(i)
    count = jResp.IntOf("sObjects[i].count")
    name = jResp.stringOf("sObjects[i].name")
    i = i + 1
end

Curl Command

curl -G -d "sObjects=Account,Contact,Lead"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/limits/recordCount

Postman Collection Item JSON

{
  "name": "Record Count",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/limits/recordCount?sObjects=Account,Contact,Lead",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "limits",
        "recordCount"
      ],
      "query": [
        {
          "key": "sObjects",
          "value": "Account,Contact,Lead",
          "description": "A comma-delimited list of object names. If a listed object is not found in the org, it is ignored and not returned in the response.\nThis parameter is optional. If this parameter is not provided, the resource returns record counts for all objects in the org."
        }
      ]
    },
    "description": "Lists information about object record counts in your organization.\nThis resource is available in REST API version 40.0 and later for API users with the “View Setup and Configuration” permission. The returned record count is approximate, and does not include the following types of records:\n\nDeleted records in the recycle bin.\nArchived records.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_record_count.htm"
  },
  "response": [
    {
      "name": "Record Count",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/limits/recordCount?sObjects=Account,Contact,Lead",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "limits",
            "recordCount"
          ],
          "query": [
            {
              "key": "sObjects",
              "value": "Account,Contact,Lead",
              "description": "A comma-delimited list of object names. If a listed object is not found in the org, it is ignored and not returned in the response.\nThis parameter is optional. If this parameter is not provided, the resource returns record counts for all objects in the org."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 27 Sep 2023 15:28:16 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=3/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"sObjects\": [\n        {\n            \"count\": 12,\n            \"name\": \"Account\"\n        },\n        {\n            \"count\": 20,\n            \"name\": \"Contact\"\n        },\n        {\n            \"count\": 22,\n            \"name\": \"Lead\"\n        }\n    ]\n}"
    }
  ]
}