GET
/
syncs
/
{sync_id}
curl --request GET \
  --url https://app.getcensus.com/api/v1/syncs/{sync_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "status": "ready",
    "id": 15135,
    "created_at": "2023-09-05T19:42:42.672Z",
    "updated_at": "2023-09-05T19:42:42.672Z",
    "match_rate_details": {
      "match_rate": 0.5,
      "match_rate_last_calculated_at": "2023-09-05T19:42:42.672Z"
    },
    "label": "New Signups to Leads",
    "operation": "mirror",
    "source_attributes": {
      "connection_id": 12,
      "object": {
        "type": "model",
        "name": "test_ads"
      }
    },
    "destination_attributes": {
      "connection_id": 15,
      "object": "user_data"
    },
    "alert_attributes": [
      {
        "type": "FailureAlertConfiguration",
        "send_for": "first_time",
        "should_send_recovery": true,
        "options": null
      },
      {
        "type": "InvalidRecordPercentAlertConfiguration",
        "send_for": "every_time",
        "should_send_recovery": false,
        "options": {
          "threshold": 10
        }
      }
    ],
    "mappings": [
      {
        "from": {
          "type": "column",
          "data": "hashed_email"
        },
        "to": "user_identifier.hashed_email_PREHASHED",
        "is_primary_identifier": true
      },
      {
        "from": {
          "type": "column",
          "data": "list_id"
        },
        "to": "list_id",
        "lookup_object": "user_list",
        "lookup_field": "name"
      },
      {
        "from": {
          "type": "constant_value",
          "data": {
            "value": "cohort_1",
            "basic_type": "text"
          }
        },
        "to": "cohort"
      }
    ],
    "advanced_configuration": {
      "data_source_country": "US, GB",
      "bulk_id_lookup": true
    },
    "mode": {
      "type": "triggered",
      "triggers": {
        "schedule": {
          "frequency": "daily",
          "hour": 10,
          "minute": 30
        }
      }
    },
    "paused": true,
    "field_behavior": "sync_all_properties",
    "field_normalization": "snake_case",
    "high_water_mark_attributes": {
      "use_high_water_mark_diff_type": true,
      "column_name": "updated_at"
    },
    "validate_only": true,
    "failed_run_notifications_enabled": true,
    "failed_record_notifications_enabled": true,
    "failed_record_notifications_threshold_percent": 10
  }
}

Authorizations

Authorization
string
headerrequired

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

sync_id
integer
required

ID of the sync

Response

200 - application/json
status
enum<string>
required

The outcome of the fetch request

Available options:
success
data
object
required