Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
- Segment Management Links
List Syncs
Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Query Parameters
Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.
Determines the number of results on each page. It can't exceed 100.
x < 100Organizes the results based on their creation time, either ascending or descending.
asc, desc Response
A successfully fetched list of results.
The list of results.
An object representing the source of the mapping. It will either be an object describing a column or a constant value.
constant_value Indicates if null values in the source should be synced to the destination.
How records are synced to the destination.
append, insert, mirror, update, upsert Attributes used to identify the data source for this sync.
The id used to identify the source connection.
Table source
The catalog of the table
The name of the table
The schema of the table
The type of your data source.
table The id used to identify the segment data source.
Set of key-value pairs that describe advanced configuration options for specific destination object types. See the specific destination's documentation for more information on available options.
FailureAlertConfiguration -- has no options
first_time, every_time FailureAlertConfiguration, InvalidRecordPercentAlertConfiguration, FullSyncTriggerAlertConfiguration, RecordCountDeviationAlertConfiguration, RuntimeAlertConfiguration, StatusAlertConfiguration The time the sync was created.
When true, will email all workspace users with email notifications enabled and all workspace additional emails when the sync has more than failed_record_notifications_threshold_percent rejected or invalid records in the source or destination.
DEPRECATION WARNING -- This field will soon be deprecated in favor of the alert_attributes object. If both this field and the alert_attributes object are present, the alert_attributes object will take precedence.
The percentage of rejected and invalid records for which failed record emails will be triggered.
DEPRECATION WARNING -- This field will soon be deprecated in favor of the alert_attributes object. If both this field and the alert_attributes object are present, the alert_attributes object will take precedence.
0 < x < 100When true, will email all workspace users with email notifications enabled and all workspace additional emails when the sync fails and recovers.
DEPRECATION WARNING -- This field will soon be deprecated in favor of the alert_attributes object. If both this field and the alert_attributes object are present, the alert_attributes object will take precedence.
Specify "sync_all_properties" to automatically update mappings.
If field_behavior is set to "sync_all_properties", specify how automatic mappings should be named.
start_case, lower_case, upper_case, camel_case, snake_case, match_source_names Specify how the destination fields should be ordered. The default behavior is alphabetically by column name. Only allowed to be set on syncs with destination objects that allow field ordering. Refer to GET /destinations/{destination_id}/objects to see if the supports_field_ordering is present on your destination object.
alphabetical_column_name, mapping_order The high water mark diffing strategy will allow append syncs to use a timestamp column when identifying new records instead of the default Census diff engine (using primary keys).
The identifier for the sync.
A label to give to this sync.
Details about the match rate for this sync. Only applies to syncs created from segments to Ad Platforms via our One Click Sync capability.
The total size of your audience in the destination divided by the total size of the sync's source. Read more on Audience match rates here. Can be null if audience size data has not been fetched yet, or if the size of the source data is 0.
The last time audience size data was fetched to calculate the match rate. Audience data is fetched daily. Can be null if audience size data has not been fetched yet.
Specify run mode for the sync.
Specify triggers for the sync. More than one type trigger can be configured.
Contains the dbt Cloud job details that should trigger the sync upon success. dbt Cloud project and job IDs can be found in the URL when navigating to a job in the dbt Cloud application or via API.
The Fivetran job details that should trigger the sync upon success. Fivetran job name can be found in the table of Connectors or Transformations via the Fivetran application and the job id can be found in the URL when navigated to the specific connector/transform details page. These information can also be retrieved via API.
Specify schedule for the sync.
Specify what cron schedule this sync should run on if the schedule_frequency is set to "experessions".
What day of the week this sync should run if schedule_frequency is set to "weekly".
Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday When this sync should be run.
never, continuous, quarter_hourly, hourly, daily, weekly, expression What hour of the day this sync should run if schedule_frequency is set to "weekly" or "daily".
0 < x < 24What minute of the hour this sync should run if scheule_frequency is set to "weekly", "daily" or "hourly".
0 < x < 59Defines mode type, can be either live or triggered.
live, triggered Whether or not this sync should be paused.
The sync's current status. Ready means that the sync has not yet run, up to date implies the last sync completed successfully and failing means that the sync failed.
ready, up to date, failing The time the sync was updated.
When true, checks if the given payload is valid to configure a sync. Does not create the sync.
An object to help you navigate the list of results.
The number of the last page with records.
The next page number, or null if it's the last page.
The current page number.
Records on each page.
The previous page number, or null for the first page.
Total records in the collection.
The outcome of the request
success Was this page helpful?