/segment-destinations | Type: Application | PCID required: Yes
Tools
segment_destinations_create_destination
Create Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enabled | boolean | No | — | Whether this Destination should receive data. |
metadataId | string | Yes | — | The id of the metadata to link to the new Destination. |
name | string | No | — | Defines the display name of the Destination. Config API note: equal to displayName. |
settings | object | Yes | — | An object that contains settings for the Destination based on the “required” and “advanced” settings present in the Destination metadata. Config API note: equal to config. |
sourceId | string | Yes | — | The id of the Source to connect to this Destination instance. Config API note: analogous to parent. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enabled": {
"type": "boolean",
"description": "Whether this Destination should receive data."
},
"metadataId": {
"type": "string",
"description": "The id of the metadata to link to the new Destination."
},
"name": {
"type": "string",
"description": "Defines the display name of the Destination. Config API note: equal to `displayName`."
},
"settings": {
"type": "object",
"description": "An object that contains settings for the Destination based on the \"required\" and \"advanced\" settings present in the Destination metadata. Config API note: equal to `config`."
},
"sourceId": {
"type": "string",
"description": "The id of the Source to connect to this Destination instance. Config API note: analogous to `parent`."
}
},
"required": [
"PCID",
"metadataId",
"settings",
"sourceId"
]
}
segment_destinations_create_destination_subscription
Create Destination Subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
actionId | string | Yes | — | The associated action id the subscription should trigger. |
enabled | boolean | Yes | — | Is the subscription enabled. |
modelId | string | No | — | When creating a Reverse ETL connection, indicates the Model being used to extract data. |
name | string | Yes | — | A user-defined name for the subscription. |
settings | object | No | — | The fields used for configuring this action. |
trigger | string | Yes | — | The FQL statement. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"actionId": {
"type": "string",
"description": "The associated action id the subscription should trigger."
},
"enabled": {
"type": "boolean",
"description": "Is the subscription enabled."
},
"modelId": {
"type": "string",
"description": "When creating a Reverse ETL connection, indicates the Model being used to extract data."
},
"name": {
"type": "string",
"description": "A user-defined name for the subscription."
},
"settings": {
"description": "The fields used for configuring this action."
},
"trigger": {
"type": "string",
"description": "The FQL statement."
}
},
"required": [
"PCID",
"destinationId",
"actionId",
"enabled",
"name",
"trigger"
]
}
segment_destinations_create_filter_for_destination
Create Filter for Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
actions | object[] | Yes | — | Actions for the Destination filter. |
description | string | No | — | The description of the filter. |
enabled | boolean | Yes | — | When set to true, the Destination filter is active. |
if | string | Yes | — | The filter’s condition. |
sourceId | string | Yes | — | The id of the Source associated with this filter. |
title | string | Yes | — | The title of the filter. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ALLOW_PROPERTIES",
"DROP",
"DROP_PROPERTIES",
"SAMPLE"
],
"description": "The kind of Transformation to apply to any matched properties."
},
"fields": {
"type": "object",
"description": "A dictionary of paths to object keys that this filter applies to. The literal string '' represents the top level of the object."
},
"percent": {
"type": "number",
"description": "A decimal between 0 and 1 used for 'sample' type events and influences the likelihood of sampling to occur."
},
"path": {
"type": "string",
"description": "The JSON path to a property within a payload object from which Segment generates a deterministic sampling rate."
}
},
"required": [
"type"
]
},
"description": "Actions for the Destination filter."
},
"description": {
"type": "string",
"description": "The description of the filter."
},
"enabled": {
"type": "boolean",
"description": "When set to true, the Destination filter is active."
},
"if": {
"type": "string",
"description": "The filter's condition."
},
"sourceId": {
"type": "string",
"description": "The id of the Source associated with this filter."
},
"title": {
"type": "string",
"description": "The title of the filter."
}
},
"required": [
"PCID",
"destinationId",
"actions",
"enabled",
"if",
"sourceId",
"title"
]
}
segment_destinations_delete_destination
Delete Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
}
},
"required": [
"PCID",
"destinationId"
]
}
segment_destinations_get_advanced_sync_schedule_from_warehouse
Get Advanced Sync Schedule from Warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouseId | string | Yes | — | Warehouse Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"warehouseId": {
"type": "string",
"description": "Warehouse Id"
}
},
"required": [
"PCID",
"warehouseId"
]
}
segment_destinations_get_destination
Get Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
}
},
"required": [
"PCID",
"destinationId"
]
}
segment_destinations_get_egress_failed_metrics_from_delivery_overview
Get Egress Failed Metrics from Delivery Overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceId | string | Yes | — | The sourceId for the Workspace. This parameter exists in beta. |
destinationConfigId | string | Yes | — | The id tied to a Workspace Destination. This parameter exists in beta. |
startTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta. |
endTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta. |
groupBy | string[] | No | — | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: event Name, event Type, discard Reason, app Version, subscription Id, activationId, audienceId, and spaceId. This parameter exists in beta. |
granularity | string | Yes | — | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: Minute: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past Hour: - Max Time range: 14 days - Oldest possible start time: 30 days in the past Day: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta. |
filter | object | No | — | An optional filter for event Name, event Type, discard Reason, app Version, subscription Id, activationId, audienceId, and/or spaceId that can be applied in addition to a group By. This parameter exists in beta. |
pagination | object | No | — | Params to specify the page cursor and count. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "The sourceId for the Workspace. This parameter exists in beta."
},
"destinationConfigId": {
"type": "string",
"description": "The id tied to a Workspace Destination. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and `spaceId`. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
},
"filter": {
"type": "object",
"description": "An optional filter for `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and/or `spaceId` that can be applied in addition to a `group By`. This parameter exists in beta.",
"properties": {
"discardReason": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of discard reasons. See [Discard Record Documentation](https://segment.com/docs/connections/delivery-overview/#troubleshooting) for valid error codes."
},
"eventName": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event names."
},
"eventType": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event types. Valid options are: `alias`, `group`, `identify`, `page`, `screen`, and `track`."
},
"appVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of app versions."
},
"subscriptionId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of subscription IDs for Actions Destinations."
},
"activationId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event context IDs from a Linked Audience mapping/activation."
},
"audienceId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of audience IDs for a Linked Audience."
},
"spaceId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of space IDs for a Linked Audience."
}
}
},
"pagination": {
"type": "object",
"description": "Params to specify the page cursor and count. This parameter exists in beta.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"sourceId",
"destinationConfigId",
"startTime",
"endTime",
"granularity"
]
}
segment_destinations_get_egress_success_metrics_from_delivery_overview
Get Egress Success Metrics from Delivery Overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceId | string | Yes | — | The sourceId for the Workspace. This parameter exists in beta. |
destinationConfigId | string | Yes | — | The id tied to a Workspace Destination. This parameter exists in beta. |
startTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta. |
endTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta. |
groupBy | string[] | No | — | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: event Name, event Type, discard Reason, app Version, subscription Id, activationId, audienceId, and spaceId. This parameter exists in beta. |
granularity | string | Yes | — | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: Minute: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past Hour: - Max Time range: 14 days - Oldest possible start time: 30 days in the past Day: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta. |
filter | object | No | — | An optional filter for event Name, event Type, discard Reason, appVersion, subscription Id, activationId, audienceId, or spaceId that can be applied in addition to a group By. If you would like to view retry attempts for a successful delivery, you can filter discard Reason from successes.attempt.1 through successes.attempt.10. This parameter exists in beta. |
pagination | object | No | — | Params to specify the page cursor and count. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "The sourceId for the Workspace. This parameter exists in beta."
},
"destinationConfigId": {
"type": "string",
"description": "The id tied to a Workspace Destination. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and `spaceId`. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
},
"filter": {
"type": "object",
"description": "An optional filter for `event Name`, `event Type`, `discard Reason`, `appVersion`, `subscription Id`, `activationId`, `audienceId`, or `spaceId` that can be applied in addition to a `group By`. If you would like to view retry attempts for a successful delivery, you can filter `discard Reason` from `successes.attempt.1` through `successes.attempt.10`. This parameter exists in beta.",
"properties": {
"discardReason": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of discard reasons. See [Discard Record Documentation](https://segment.com/docs/connections/delivery-overview/#troubleshooting) for valid error codes."
},
"eventName": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event names."
},
"eventType": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event types. Valid options are: `alias`, `group`, `identify`, `page`, `screen`, and `track`."
},
"appVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of app versions."
},
"subscriptionId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of subscription IDs for Actions Destinations."
},
"activationId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event context IDs from a Linked Audience mapping/activation."
},
"audienceId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of audience IDs for a Linked Audience."
},
"spaceId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of space IDs for a Linked Audience."
}
}
},
"pagination": {
"type": "object",
"description": "Params to specify the page cursor and count. This parameter exists in beta.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"sourceId",
"destinationConfigId",
"startTime",
"endTime",
"granularity"
]
}
segment_destinations_get_filter_in_destination
Get Filter in Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
filterId | string | Yes | — | Filter Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"filterId": {
"type": "string",
"description": "Filter Id"
}
},
"required": [
"PCID",
"destinationId",
"filterId"
]
}
segment_destinations_get_filtered_at_destination_metrics_from_delivery_overview
Get Filtered At Destination Metrics from Delivery Overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceId | string | Yes | — | The sourceId for the Workspace. This parameter exists in beta. |
destinationConfigId | string | Yes | — | The id tied to a Workspace Destination. This parameter exists in beta. |
startTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta. |
endTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta. |
groupBy | string[] | No | — | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: event Name, event Type, discard Reason, app Version, subscription Id, activationId, audienceId, and spaceId. This parameter exists in beta. |
granularity | string | Yes | — | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: Minute: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past Hour: - Max Time range: 14 days - Oldest possible start time: 30 days in the past Day: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta. |
filter | object | No | — | An optional filter for event Name, event Type, discard Reason, app Version, subscription Id, activationId, audienceId, and/or spaceId that can be applied in addition to a group By. This parameter exists in beta. |
pagination | object | No | — | Params to specify the page cursor and count. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "The sourceId for the Workspace. This parameter exists in beta."
},
"destinationConfigId": {
"type": "string",
"description": "The id tied to a Workspace Destination. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and `spaceId`. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
},
"filter": {
"type": "object",
"description": "An optional filter for `event Name`, `event Type`, `discard Reason`, `app Version`, `subscription Id`, `activationId`, `audienceId`, and/or `spaceId` that can be applied in addition to a `group By`. This parameter exists in beta.",
"properties": {
"discardReason": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of discard reasons. See [Discard Record Documentation](https://segment.com/docs/connections/delivery-overview/#troubleshooting) for valid error codes."
},
"eventName": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event names."
},
"eventType": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event types. Valid options are: `alias`, `group`, `identify`, `page`, `screen`, and `track`."
},
"appVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of app versions."
},
"subscriptionId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of subscription IDs for Actions Destinations."
},
"activationId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event context IDs from a Linked Audience mapping/activation."
},
"audienceId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of audience IDs for a Linked Audience."
},
"spaceId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of space IDs for a Linked Audience."
}
}
},
"pagination": {
"type": "object",
"description": "Params to specify the page cursor and count. This parameter exists in beta.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"sourceId",
"destinationConfigId",
"startTime",
"endTime",
"granularity"
]
}
segment_destinations_get_filtered_at_source_metrics_from_delivery_overview
Get Filtered At Source Metrics from Delivery Overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceId | string | Yes | — | The sourceId for the Workspace. This parameter exists in beta. |
startTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta. |
endTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta. |
groupBy | string[] | No | — | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: event Name, event Type, discard Reason, and app Version. This parameter exists in beta. |
granularity | string | Yes | — | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: Minute: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past Hour: - Max Time range: 14 days - Oldest possible start time: 30 days in the past Day: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta. |
filter | object | No | — | An optional filter for event Name, event Type, discard Reason, and/or app Version that can be applied in addition to a group By. This parameter exists in beta. |
pagination | object | No | — | Optional params to specify the page cursor and count. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "The sourceId for the Workspace. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, and `app Version`. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
},
"filter": {
"type": "object",
"description": "An optional filter for `event Name`, `event Type`, `discard Reason`, and/or `app Version` that can be applied in addition to a `group By`. This parameter exists in beta.",
"properties": {
"discardReason": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of discard reasons. See [Discard Record Documentation](https://segment.com/docs/connections/delivery-overview/#troubleshooting) for valid error codes."
},
"eventName": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event names."
},
"eventType": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event types. Valid options are: `alias`, `group`, `identify`, `page`, `screen`, and `track`."
},
"appVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of app versions."
}
}
},
"pagination": {
"type": "object",
"description": "Optional params to specify the page cursor and count. This parameter exists in beta.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"sourceId",
"startTime",
"endTime",
"granularity"
]
}
segment_destinations_get_ingress_failed_metrics_from_delivery_overview
Get Ingress Failed Metrics from Delivery Overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceId | string | Yes | — | The sourceId for the Workspace. This parameter exists in beta. |
startTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta. |
endTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta. |
groupBy | string[] | No | — | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: event Name, event Type, discard Reason, and/or appVersion. This parameter exists in beta. |
granularity | string | Yes | — | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: Minute: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past Hour: - Max Time range: 14 days - Oldest possible start time: 30 days in the past Day: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta. |
filter | object | No | — | An optional filter for event Name, event Type, discard Reason, and/or app Version that can be applied in addition to a group By. This parameter exists in beta. |
pagination | object | No | — | Optional params to specify the page cursor and count. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "The sourceId for the Workspace. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, `discard Reason`, and/or `appVersion`. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
},
"filter": {
"type": "object",
"description": "An optional filter for `event Name`, `event Type`, `discard Reason`, and/or `app Version` that can be applied in addition to a `group By`. This parameter exists in beta.",
"properties": {
"discardReason": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of discard reasons. See [Discard Record Documentation](https://segment.com/docs/connections/delivery-overview/#troubleshooting) for valid error codes."
},
"eventName": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event names."
},
"eventType": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event types. Valid options are: `alias`, `group`, `identify`, `page`, `screen`, and `track`."
},
"appVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of app versions."
}
}
},
"pagination": {
"type": "object",
"description": "Optional params to specify the page cursor and count. This parameter exists in beta.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"sourceId",
"startTime",
"endTime",
"granularity"
]
}
segment_destinations_get_ingress_success_metrics_from_delivery_overview
Get Ingress Success Metrics from Delivery Overview Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceId | string | Yes | — | The sourceId for the Workspace. This parameter exists in beta. |
startTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta. |
endTime | string | Yes | — | The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta. |
groupBy | string[] | No | — | A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: event Name, event Type, and/or app Version. This parameter exists in beta. |
granularity | string | Yes | — | The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: Minute: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past Hour: - Max Time range: 14 days - Oldest possible start time: 30 days in the past Day: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta. |
filter | object | No | — | An optional filter for event Name, event Type, and/or app Version that can be applied in addition to a group By. This parameter exists in beta. |
pagination | object | No | — | Optional params to specify the page cursor and count. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "The sourceId for the Workspace. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the beginning of the requested time frame, inclusive. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "The ISO8601 formatted timestamp corresponding to the end of the requested time frame, noninclusive. This parameter exists in beta."
},
"groupBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-delimited list of strings representing one or more dimensions to group the result by. Valid options are: `event Name`, `event Type`, and/or `app Version`. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The size of each bucket in the requested window. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 14 days - Oldest possible start time: 30 days in the past **Day**: - Max time range: 30 days - Oldest possible start time: 30 days in the past This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
},
"filter": {
"type": "object",
"description": "An optional filter for `event Name`, `event Type`, and/or `app Version` that can be applied in addition to a `group By`. This parameter exists in beta.",
"properties": {
"eventName": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event names."
},
"eventType": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of event types. Valid options are: `alias`, `group`, `identify`, `page`, `screen`, and `track`."
},
"appVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of strings of app versions."
}
}
},
"pagination": {
"type": "object",
"description": "Optional params to specify the page cursor and count. This parameter exists in beta.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"sourceId",
"startTime",
"endTime",
"granularity"
]
}
segment_destinations_get_subscription_from_destination
Get Subscription from Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"destinationId",
"id"
]
}
segment_destinations_list_delivery_metrics_summary_from_destination
List Delivery Metrics Summary from Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
sourceId | string | Yes | — | The id of the Source linked to the Destination. Config API note: analogous to parent. This parameter exists in beta. |
startTime | string | No | — | Filter events that happened after this time. Defaults to: - 1 hour ago if granularity is MINUTE. - 7 days ago if granularity is HOUR. - 30 days ago if granularity is DAY. This parameter exists in beta. |
endTime | string | No | — | Filter events that happened before this time. Defaults to now if not set. This parameter exists in beta. |
granularity | string | No | — | The granularity to filter metrics to. Either MINUTE, HOUR or DAY. Defaults to MINUTE if not set. This parameter exists in beta. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"sourceId": {
"type": "string",
"description": "The id of the Source linked to the Destination. Config API note: analogous to `parent`. This parameter exists in beta."
},
"startTime": {
"type": "string",
"description": "Filter events that happened after this time. Defaults to: - 1 hour ago if granularity is `MINUTE`. - 7 days ago if granularity is `HOUR`. - 30 days ago if granularity is `DAY`. This parameter exists in beta."
},
"endTime": {
"type": "string",
"description": "Filter events that happened before this time. Defaults to now if not set. This parameter exists in beta."
},
"granularity": {
"type": "string",
"description": "The granularity to filter metrics to. Either `MINUTE`, `HOUR` or `DAY`. Defaults to `MINUTE` if not set. This parameter exists in beta.",
"enum": [
"DAY",
"HOUR",
"MINUTE"
]
}
},
"required": [
"PCID",
"destinationId",
"sourceId"
]
}
segment_destinations_list_destinations
List Destinations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagination | object | No | — | Required pagination params for the request. This parameter exists in v1. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pagination": {
"type": "object",
"description": "Required pagination params for the request. This parameter exists in v1.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID"
]
}
segment_destinations_list_filters_from_destination
List Filters from Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
pagination | object | No | — | Pagination options. This parameter exists in v1. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"pagination": {
"type": "object",
"description": "Pagination options. This parameter exists in v1.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"destinationId"
]
}
segment_destinations_list_selective_syncs_from_warehouse_and_source
List Selective Syncs from Warehouse And Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouseId | string | Yes | — | Warehouse Id |
sourceId | string | Yes | — | Source Id |
pagination | object | No | — | Defines the pagination parameters. This parameter exists in v1. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"warehouseId": {
"type": "string",
"description": "Warehouse Id"
},
"sourceId": {
"type": "string",
"description": "Source Id"
},
"pagination": {
"type": "object",
"description": "Defines the pagination parameters. This parameter exists in v1.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"warehouseId",
"sourceId"
]
}
segment_destinations_list_subscriptions_from_destination
List Subscriptions from Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
pagination | object | No | — | Pagination options. This parameter exists in alpha. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"pagination": {
"type": "object",
"description": "Pagination options. This parameter exists in alpha.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"destinationId"
]
}
segment_destinations_list_syncs_from_warehouse
List Syncs from Warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouseId | string | Yes | — | Warehouse Id |
pagination | object | No | — | Defines the pagination parameters. This parameter exists in v1. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"warehouseId": {
"type": "string",
"description": "Warehouse Id"
},
"pagination": {
"type": "object",
"description": "Defines the pagination parameters. This parameter exists in v1.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"warehouseId"
]
}
segment_destinations_list_syncs_from_warehouse_and_source
List Syncs from Warehouse And Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouseId | string | Yes | — | Warehouse Id |
sourceId | string | Yes | — | Source Id |
pagination | object | No | — | Defines the pagination parameters. This parameter exists in v1. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"warehouseId": {
"type": "string",
"description": "Warehouse Id"
},
"sourceId": {
"type": "string",
"description": "Source Id"
},
"pagination": {
"type": "object",
"description": "Defines the pagination parameters. This parameter exists in v1.",
"properties": {
"cursor": {
"type": "string",
"description": "The page to request. Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys. Consumers of the API must treat this value as opaque."
},
"count": {
"type": "integer",
"description": "The number of items to retrieve in a page, between 1 and 1000."
}
},
"required": [
"count"
]
}
},
"required": [
"PCID",
"warehouseId",
"sourceId"
]
}
segment_destinations_preview_destination_filter
Preview Destination Filter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | object | Yes | — | The filter to preview. |
payload | object | Yes | — | The JSON payload to apply the filter to. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter": {
"description": "The filter to preview."
},
"payload": {
"type": "object",
"description": "The JSON payload to apply the filter to."
}
},
"required": [
"PCID",
"filter",
"payload"
]
}
segment_destinations_remove_filter_from_destination
Remove Filter from Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
filterId | string | Yes | — | Filter Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"filterId": {
"type": "string",
"description": "Filter Id"
}
},
"required": [
"PCID",
"destinationId",
"filterId"
]
}
segment_destinations_remove_subscription_from_destination
Remove Subscription from Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"destinationId",
"id"
]
}
segment_destinations_replace_advanced_sync_schedule_for_warehouse
Replace Advanced Sync Schedule for Warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouseId | string | Yes | — | Warehouse Id |
enabled | boolean | Yes | — | Enable to turn on an advanced sync schedule for the Warehouse. |
schedule | object | No | — | The full sync schedule for the Warehouse. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"warehouseId": {
"type": "string",
"description": "Warehouse Id"
},
"enabled": {
"type": "boolean",
"description": "Enable to turn on an advanced sync schedule for the Warehouse."
},
"schedule": {
"description": "The full sync schedule for the Warehouse."
}
},
"required": [
"PCID",
"warehouseId",
"enabled"
]
}
segment_destinations_update_destination
Update Destination Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id | |
enabled | boolean | No | — | Whether this Destination should receive data. | |
name | string | null | No | — | Defines the display name of the Destination. Config API note: equal to displayName. |
settings | object | No | — | An optional object that contains settings for the Destination based on the “required” and “advanced” settings present in the Destination metadata. Config API note: equal to config. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"enabled": {
"type": "boolean",
"description": "Whether this Destination should receive data."
},
"name": {
"type": [
"string",
"null"
],
"description": "Defines the display name of the Destination. Config API note: equal to `displayName`."
},
"settings": {
"type": "object",
"description": "An optional object that contains settings for the Destination based on the \"required\" and \"advanced\" settings present in the Destination metadata. Config API note: equal to `config`."
}
},
"required": [
"PCID",
"destinationId"
]
}
segment_destinations_update_filter_for_destination
Update Filter for Destination Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id | |
filterId | string | Yes | — | Filter Id | |
actions | object[] | No | — | Actions for this Destination filter. | |
description | string | null | No | — | The description of this filter. |
enabled | boolean | No | — | When set to true, this Destination filter is active. | |
if | string | No | — | The FQL if condition to update. | |
title | string | No | — | The title to update. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"filterId": {
"type": "string",
"description": "Filter Id"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ALLOW_PROPERTIES",
"DROP",
"DROP_PROPERTIES",
"SAMPLE"
],
"description": "The kind of Transformation to apply to any matched properties."
},
"fields": {
"type": "object",
"description": "A dictionary of paths to object keys that this filter applies to. The literal string '' represents the top level of the object."
},
"percent": {
"type": "number",
"description": "A decimal between 0 and 1 used for 'sample' type events and influences the likelihood of sampling to occur."
},
"path": {
"type": "string",
"description": "The JSON path to a property within a payload object from which Segment generates a deterministic sampling rate."
}
},
"required": [
"type"
]
},
"description": "Actions for this Destination filter."
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of this filter."
},
"enabled": {
"type": "boolean",
"description": "When set to true, this Destination filter is active."
},
"if": {
"type": "string",
"description": "The FQL if condition to update."
},
"title": {
"type": "string",
"description": "The title to update."
}
},
"required": [
"PCID",
"destinationId",
"filterId"
]
}
segment_destinations_update_selective_sync_for_warehouse
Update Selective Sync for Warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
warehouseId | string | Yes | — | Warehouse Id |
syncOverrides | object[] | No | — | A list of sync schema overrides to apply to this Warehouse. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"warehouseId": {
"type": "string",
"description": "Warehouse Id"
},
"syncOverrides": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"description": "The id of the Source this schema item applies to."
},
"collection": {
"type": "string",
"description": "The collection the schema item override applies to."
},
"enabled": {
"type": "boolean",
"description": "Enable to apply the override."
},
"property": {
"type": "string",
"description": "A property within the collection to which the override applies."
}
},
"required": [
"enabled",
"sourceId"
]
},
"description": "A list of sync schema overrides to apply to this Warehouse."
}
},
"required": [
"PCID",
"warehouseId"
]
}
segment_destinations_update_subscription_for_destination
Update Subscription for Destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destinationId | string | Yes | — | Destination Id |
id | string | Yes | — | The id value |
input | object | Yes | — | A set of valid Destination input params required for updating. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destinationId": {
"type": "string",
"description": "Destination Id"
},
"id": {
"type": "string",
"description": "The id value"
},
"input": {
"description": "A set of valid Destination input params required for updating."
}
},
"required": [
"PCID",
"destinationId",
"id",
"input"
]
}