Fetch Records Count

Retrieves the count of all records synced during a given sync run. Filters can be applied to get specific counts.

Request schema

Path parameters

sync_run_id

integerrequired

ID of the sync run

Query parameters

primary_identifier

string

Filter records by the primary identifier of the record.

status

string

Filter records by successfully synced, invalid in source, or rejected by destination.

enum:

"succeeded""rejected""invalid"

operation

string

Filter by whether Census tried to create or update the record (upsert) or delete the record (delete) in the destination.

enum:

"upsert""delete"

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}/records_count

GET /api/v1/sync_runs/{sync_run_id}/records_count?primary_identifier=SOME_STRING_VALUE&status=SOME_STRING_VALUE&operation=SOME_STRING_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved record counts.

404

Resource not found.

`200`

status

stringrequired

The outcome of the fetch request.

enum:

"success"

data

arrayrequired

record_count

integer

The count of records that match the filters provided in query.

example:

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status": "success",
  "data": [
    {
      "record_count": 25
    }
  ]
}