segment-sources

Segment Sources — manage data sources, catalog, labels, and workspace info

Server path: /segment-sources | Type: Application | PCID required: Yes

Tools

Tool	Description
segment_sources_add_labels_to_source	Add Labels to Source
segment_sources_create_label	Create Label
segment_sources_create_source	Create Source
segment_sources_create_write_key_for_source	Create Write Key for Source
segment_sources_delete_label	Delete Label
segment_sources_delete_source	Delete Source
segment_sources_get_catalog	Get Sources Catalog
segment_sources_get_destination_metadata	Get Destination Metadata
segment_sources_get_destinations_catalog	Get Destinations Catalog
segment_sources_get_source	Get Source
segment_sources_get_source_metadata	Get Source Metadata
segment_sources_get_warehouse_metadata	Get Warehouse Metadata
segment_sources_get_warehouses_catalog	Get Warehouses Catalog
segment_sources_get_workspace	Get Workspace
segment_sources_list_connected_destinations_from_source	List Connected Destinations from Source
segment_sources_list_connected_warehouses_from_source	List Connected Warehouses from Source
segment_sources_list_labels	List Labels
segment_sources_list_schema_settings_in_source	List Schema Settings in Source
segment_sources_list_sources	List Sources
segment_sources_remove_write_key_from_source	Remove Write Key from Source
segment_sources_replace_labels_in_source	Replace Labels in Source
segment_sources_update_schema_settings_in_source	Update Schema Settings in Source
segment_sources_update_source	Update Source

---

segment_sources_add_labels_to_source

Add Labels to Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
labels	object[]	Yes	—	The labels to associate with a Source.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The key that represents the name of this label."
          },
          "value": {
            "type": "string",
            "description": "The value associated with the key of this label."
          },
          "description": {
            "type": "string",
            "description": "An optional description of the purpose of this label."
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "description": "The labels to associate with a Source."
    }
  },
  "required": [
    "PCID",
    "sourceId",
    "labels"
  ]
}

---

segment_sources_create_label

Create Label

Parameters:

Parameter	Type	Required	Default	Description
label	object	Yes	—	The new label to create in the Workspace.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "label": {
      "description": "The new label to create in the Workspace."
    }
  },
  "required": [
    "PCID",
    "label"
  ]
}

---

segment_sources_create_source

Create Source

Parameters:

Parameter	Type	Required	Default	Description
disconnectAllWarehouses	boolean	No	—	Whether to disconnect all Warehouses from the Source.
enabled	boolean	Yes	—	Enable to allow this Source to send data. Defaults to true.
metadataId	string	Yes	—	The id of the Source metadata from which this instance of the Source derives. All Source metadata is available under /catalog/sources.
settings	object	No	—	A key-value object that contains instance-specific settings for the Source. “websiteUrl” and “apiHost” can be configured here for the relevant Sources.
slug	string	Yes	—	The slug by which to identify the Source in the Segment app.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "disconnectAllWarehouses": {
      "type": "boolean",
      "description": "Whether to disconnect all Warehouses from the Source."
    },
    "enabled": {
      "type": "boolean",
      "description": "Enable to allow this Source to send data. Defaults to true."
    },
    "metadataId": {
      "type": "string",
      "description": "The id of the Source metadata from which this instance of the Source derives.  All Source metadata is available under `/catalog/sources`."
    },
    "settings": {
      "description": "A key-value object that contains instance-specific settings for the Source.  \"websiteUrl\" and \"apiHost\" can be configured here for the relevant Sources."
    },
    "slug": {
      "type": "string",
      "description": "The slug by which to identify the Source in the Segment app."
    }
  },
  "required": [
    "PCID",
    "enabled",
    "metadataId",
    "slug"
  ]
}

---

segment_sources_create_write_key_for_source

Create Write Key for Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    }
  },
  "required": [
    "PCID",
    "sourceId"
  ]
}

---

segment_sources_delete_label

Delete Label

Parameters:

Parameter	Type	Required	Default	Description
key	string	Yes	—	The key value
value	string	Yes	—	The value value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "key": {
      "type": "string",
      "description": "The key value"
    },
    "value": {
      "type": "string",
      "description": "The value value"
    }
  },
  "required": [
    "PCID",
    "key",
    "value"
  ]
}

---

segment_sources_delete_source

Delete Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    }
  },
  "required": [
    "PCID",
    "sourceId"
  ]
}

---

segment_sources_get_catalog

Get Sources Catalog

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Defines the pagination parameters. This parameter exists in v1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "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"
  ]
}

---

segment_sources_get_destination_metadata

Get Destination Metadata

Parameters:

Parameter	Type	Required	Default	Description
destinationMetadataId	string	Yes	—	Destination Metadata Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "destinationMetadataId": {
      "type": "string",
      "description": "Destination Metadata Id"
    }
  },
  "required": [
    "PCID",
    "destinationMetadataId"
  ]
}

---

segment_sources_get_destinations_catalog

Get Destinations Catalog

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Required pagination parameters used to filter the Destinations catalog. This parameter exists in v1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Required pagination parameters used to filter the Destinations catalog.  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_sources_get_source

Get Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    }
  },
  "required": [
    "PCID",
    "sourceId"
  ]
}

---

segment_sources_get_source_metadata

Get Source Metadata

Parameters:

Parameter	Type	Required	Default	Description
sourceMetadataId	string	Yes	—	Source Metadata Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceMetadataId": {
      "type": "string",
      "description": "Source Metadata Id"
    }
  },
  "required": [
    "PCID",
    "sourceMetadataId"
  ]
}

---

segment_sources_get_warehouse_metadata

Get Warehouse Metadata

Parameters:

Parameter	Type	Required	Default	Description
warehouseMetadataId	string	Yes	—	Warehouse Metadata Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "warehouseMetadataId": {
      "type": "string",
      "description": "Warehouse Metadata Id"
    }
  },
  "required": [
    "PCID",
    "warehouseMetadataId"
  ]
}

---

segment_sources_get_warehouses_catalog

Get Warehouses Catalog

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Optional pagination params used to filter the Warehouses catalog. This parameter exists in v1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Optional pagination params used to filter the Warehouses catalog.  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_sources_get_workspace

Get Workspace

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

segment_sources_list_connected_destinations_from_source

List Connected Destinations from Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
pagination	object	No	—	Required pagination params for the request. This parameter exists in alpha.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "pagination": {
      "type": "object",
      "description": "Required pagination params for the request.  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",
    "sourceId"
  ]
}

---

segment_sources_list_connected_warehouses_from_source

List Connected Warehouses from Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
pagination	object	No	—	Required pagination params for the request. This parameter exists in alpha.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "pagination": {
      "type": "object",
      "description": "Required pagination params for the request.  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",
    "sourceId"
  ]
}

---

segment_sources_list_labels

List Labels

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

segment_sources_list_schema_settings_in_source

List Schema Settings in Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    }
  },
  "required": [
    "PCID",
    "sourceId"
  ]
}

---

segment_sources_list_sources

List Sources

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Defines the pagination parameters. This parameter exists in alpha.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Defines the pagination parameters.  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"
  ]
}

---

segment_sources_remove_write_key_from_source

Remove Write Key from Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
writeKey	string	Yes	—	Write Key

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "writeKey": {
      "type": "string",
      "description": "Write Key"
    }
  },
  "required": [
    "PCID",
    "sourceId",
    "writeKey"
  ]
}

---

segment_sources_replace_labels_in_source

Replace Labels in Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
labels	object[]	Yes	—	The list of labels to replace in the Source.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The key that represents the name of this label."
          },
          "value": {
            "type": "string",
            "description": "The value associated with the key of this label."
          },
          "description": {
            "type": "string",
            "description": "An optional description of the purpose of this label."
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "description": "The list of labels to replace in the Source."
    }
  },
  "required": [
    "PCID",
    "sourceId",
    "labels"
  ]
}

---

segment_sources_update_schema_settings_in_source

Update Schema Settings in Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
forwardingBlockedEventsTo	string	No	—	Source id to forward blocked events to.
forwardingViolationsTo	string	No	—	Source id to forward violations to.
group	object	No	—	Group settings.
identify	object	No	—	Identify settings.
track	object	No	—	Track settings.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "forwardingBlockedEventsTo": {
      "type": "string",
      "description": "Source id to forward blocked events to."
    },
    "forwardingViolationsTo": {
      "type": "string",
      "description": "Source id to forward violations to."
    },
    "group": {
      "description": "Group settings."
    },
    "identify": {
      "description": "Identify settings."
    },
    "track": {
      "description": "Track settings."
    }
  },
  "required": [
    "PCID",
    "sourceId"
  ]
}

---

segment_sources_update_source

Update Source

Parameters:

Parameter	Type	Required	Default	Description
sourceId	string	Yes	—	Source Id
enabled	boolean	No	—	Enable to allow the Source to send data.
name	string	No	—	An optional human-readable name to associate with the Source. Config API note: equal to displayName.
settings	object	No	—	A key-value object that contains instance-specific settings for the Source. Different kinds of Sources require different kinds of input. The settings input for a Source comes from the options object associated with this instance of a Source. You can find the full list of required settings by accessing the Sources catalog endpoint under /catalog/sources.
slug	string	No	—	The slug that identifies the Source. Config API note: equal to name.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sourceId": {
      "type": "string",
      "description": "Source Id"
    },
    "enabled": {
      "type": "boolean",
      "description": "Enable to allow the Source to send data."
    },
    "name": {
      "type": "string",
      "description": "An optional human-readable name to associate with the Source.  Config API note: equal to `displayName`."
    },
    "settings": {
      "description": "A key-value object that contains instance-specific settings for the Source.  Different kinds of Sources require different kinds of input. The settings input for a Source comes from the `options` object associated with this instance of a Source.  You can find the full list of required settings by accessing the Sources catalog endpoint under `/catalog/sources`."
    },
    "slug": {
      "type": "string",
      "description": "The slug that identifies the Source.  Config API note: equal to `name`."
    }
  },
  "required": [
    "PCID",
    "sourceId"
  ]
}