> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# segment-tracking

> Segment Tracking — manage tracking plans, events, testing, and transformations

**Server path:** `/segment-tracking` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                      | Description                      |
| --------------------------------------------------------------------------------------------------------- | -------------------------------- |
| [`segment_tracking_add_source_to_tracking_plan`](#segment_tracking_add_source_to_tracking_plan)           | Add Source to Tracking Plan      |
| [`segment_tracking_create_tracking_plan`](#segment_tracking_create_tracking_plan)                         | Create Tracking Plan             |
| [`segment_tracking_create_transformation`](#segment_tracking_create_transformation)                       | Create Transformation            |
| [`segment_tracking_delete_plan`](#segment_tracking_delete_plan)                                           | Delete Tracking Plan             |
| [`segment_tracking_delete_transformation`](#segment_tracking_delete_transformation)                       | Delete Transformation            |
| [`segment_tracking_echo`](#segment_tracking_echo)                                                         | Echo                             |
| [`segment_tracking_get_events_volume_from_workspace`](#segment_tracking_get_events_volume_from_workspace) | Get Events Volume from Workspace |
| [`segment_tracking_get_plan`](#segment_tracking_get_plan)                                                 | Get Tracking Plan                |
| [`segment_tracking_get_transformation`](#segment_tracking_get_transformation)                             | Get Transformation               |
| [`segment_tracking_list_rules_from_tracking_plan`](#segment_tracking_list_rules_from_tracking_plan)       | List Rules from Tracking Plan    |
| [`segment_tracking_list_sources_from_tracking_plan`](#segment_tracking_list_sources_from_tracking_plan)   | List Sources from Tracking Plan  |
| [`segment_tracking_list_tracking_plans`](#segment_tracking_list_tracking_plans)                           | List Tracking Plans              |
| [`segment_tracking_list_transformations`](#segment_tracking_list_transformations)                         | List Transformations             |
| [`segment_tracking_remove_rules_from_tracking_plan`](#segment_tracking_remove_rules_from_tracking_plan)   | Remove Rules from Tracking Plan  |
| [`segment_tracking_remove_source_from_tracking_plan`](#segment_tracking_remove_source_from_tracking_plan) | Remove Source from Tracking Plan |
| [`segment_tracking_replace_rules_in_tracking_plan`](#segment_tracking_replace_rules_in_tracking_plan)     | Replace Rules in Tracking Plan   |
| [`segment_tracking_update_rules_in_tracking_plan`](#segment_tracking_update_rules_in_tracking_plan)       | Update Rules in Tracking Plan    |
| [`segment_tracking_update_tracking_plan`](#segment_tracking_update_tracking_plan)                         | Update Tracking Plan             |
| [`segment_tracking_update_transformation`](#segment_tracking_update_transformation)                       | Update Transformation            |

***

## segment\_tracking\_add\_source\_to\_tracking\_plan

Add Source to Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                                                          |
| ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id                                                                                     |
| `sourceId`       | string | Yes      | —       | The id of the Source associated with the Tracking Plan.  Config API note: analogous to `sourceName`. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      },
      "sourceId": {
        "type": "string",
        "description": "The id of the Source associated with the Tracking Plan.  Config API note: analogous to `sourceName`."
      }
    },
    "required": [
      "PCID",
      "trackingPlanId",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_create\_tracking\_plan

Create Tracking Plan

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                         |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `description` | string | No       | —       | The Tracking Plan's description.                                    |
| `name`        | string | Yes      | —       | The Tracking Plan's name.  Config API note: equal to `displayName`. |
| `type`        | string | Yes      | —       | The Tracking Plan's type.                                           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "description": {
        "type": "string",
        "description": "The Tracking Plan's description."
      },
      "name": {
        "type": "string",
        "description": "The Tracking Plan's name.  Config API note: equal to `displayName`."
      },
      "type": {
        "type": "string",
        "description": "The Tracking Plan's type.",
        "enum": [
          "ENGAGE",
          "LIVE",
          "PROPERTY_LIBRARY",
          "RULE_LIBRARY",
          "TEMPLATE"
        ]
      }
    },
    "required": [
      "PCID",
      "name",
      "type"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_create\_transformation

Create Transformation

**Parameters:**

| Parameter                      | Type      | Required | Default | Description                                                                                                                                                                                                                                  |
| ------------------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowProperties`              | string\[] | No       | —       | Optional array for allowing properties from your events.                                                                                                                                                                                     |
| `destinationMetadataId`        | string    | No       | —       | The optional Destination metadata id to be associated with the Transformation.                                                                                                                                                               |
| `drop`                         | boolean   | No       | —       | Optional boolean value if the Transformation should drop the event entirely when the if statement matches, ignores all other transforms.                                                                                                     |
| `enabled`                      | boolean   | Yes      | —       | If the Transformation should be enabled.                                                                                                                                                                                                     |
| `fqlDefinedProperties`         | object\[] | No       | —       | Optional array for defining new properties in [FQL](https://segment.com/docs/config-api/fql/). Currently limited to 1 property.                                                                                                              |
| `hashPropertiesConfiguration`  | object    | No       | —       | Optional object for hashing properties within an event.                                                                                                                                                                                      |
| `if`                           | string    | Yes      | —       | If statement ([FQL](https://segment.com/docs/config-api/fql/)) to match events.  For standard event matchers, use the following:  Track -\&gt; "event='\&lt;eventName\&gt;'"  Identify -\&gt; "type='identify'"  Group -\&gt; "type='group'" |
| `name`                         | string    | Yes      | —       | The name of the Transformation.                                                                                                                                                                                                              |
| `newEventName`                 | string    | No       | —       | Optional new event name for renaming events. Works only for 'track' event type.                                                                                                                                                              |
| `propertyRenames`              | object\[] | No       | —       | Optional array for renaming properties collected by your events.                                                                                                                                                                             |
| `propertyValueTransformations` | object\[] | No       | —       | Optional array for transforming properties and values collected by your events. Limited to 10 properties.                                                                                                                                    |
| `sourceId`                     | string    | Yes      | —       | The Source to be associated with the Transformation.                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "allowProperties": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Optional array for allowing properties from your events."
      },
      "destinationMetadataId": {
        "type": "string",
        "description": "The optional Destination metadata id to be associated with the Transformation."
      },
      "drop": {
        "type": "boolean",
        "description": "Optional boolean value if the Transformation should drop the event entirely when the if statement matches, ignores all other transforms."
      },
      "enabled": {
        "type": "boolean",
        "description": "If the Transformation should be enabled."
      },
      "fqlDefinedProperties": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "fql": {
              "type": "string",
              "description": "The FQL expression used to compute the property."
            },
            "propertyName": {
              "type": "string",
              "description": "The new property name."
            }
          },
          "required": [
            "fql",
            "propertyName"
          ]
        },
        "description": "Optional array for defining new properties in [FQL](https://segment.com/docs/config-api/fql/). Currently limited to 1 property."
      },
      "hashPropertiesConfiguration": {
        "description": "Optional object for hashing properties within an event."
      },
      "if": {
        "type": "string",
        "description": "If statement ([FQL](https://segment.com/docs/config-api/fql/)) to match events.  For standard event matchers, use the following:  Track -\\> \"event='\\<eventName\\>'\"  Identify -\\> \"type='identify'\"  Group -\\> \"type='group'\""
      },
      "name": {
        "type": "string",
        "description": "The name of the Transformation."
      },
      "newEventName": {
        "type": "string",
        "description": "Optional new event name for renaming events. Works only for 'track' event type."
      },
      "propertyRenames": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "oldName": {
              "type": "string",
              "description": "The old name of the property."
            },
            "newName": {
              "type": "string",
              "description": "The new name to rename the property."
            }
          },
          "required": [
            "newName",
            "oldName"
          ]
        },
        "description": "Optional array for renaming properties collected by your events."
      },
      "propertyValueTransformations": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "propertyPaths": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The property paths. The maximum number of paths is 10."
            },
            "propertyValue": {
              "type": "string",
              "description": "The new value of the property paths."
            }
          },
          "required": [
            "propertyPaths",
            "propertyValue"
          ]
        },
        "description": "Optional array for transforming properties and values collected by your events. Limited to 10 properties."
      },
      "sourceId": {
        "type": "string",
        "description": "The Source to be associated with the Transformation."
      }
    },
    "required": [
      "PCID",
      "enabled",
      "if",
      "name",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_delete\_plan

Delete Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      }
    },
    "required": [
      "PCID",
      "trackingPlanId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_delete\_transformation

Delete Transformation

**Parameters:**

| Parameter          | Type   | Required | Default | Description       |
| ------------------ | ------ | -------- | ------- | ----------------- |
| `transformationId` | string | Yes      | —       | Transformation Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "transformationId": {
        "type": "string",
        "description": "Transformation Id"
      }
    },
    "required": [
      "PCID",
      "transformationId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_echo

Echo

**Parameters:**

| Parameter                | Type    | Required | Default | Description                                                                                                                                                                                                |
| ------------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message`                | string  | Yes      | —       | Sets the response `message` field. The response contains this field's entry.  This parameter exists in alpha.                                                                                              |
| `delay`                  | number  | No       | —       | The desired response delay, in milliseconds.  This parameter exists in alpha.                                                                                                                              |
| `triggerError`           | boolean | No       | —       | If `true`, returns an HTTP `4xx` error that contains the string in `message`.  This parameter exists in alpha.                                                                                             |
| `triggerMultipleErrors`  | boolean | No       | —       | If `true`, returns an HTTP `4xx` error that contains the value of the `message` field in the error message array.  This has no effect if the request sets `triggerError`.  This parameter exists in alpha. |
| `triggerUnexpectedError` | boolean | No       | —       | If `true`, triggers a `500` error.  This has no effect if the request sets either `triggerError` or `triggerMultipleErrors`.  This parameter exists in alpha.                                              |
| `statusCode`             | number  | No       | —       | Sets the HTTP status code to return.  This parameter exists in alpha.                                                                                                                                      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "message": {
        "type": "string",
        "description": "Sets the response `message` field. The response contains this field's entry.  This parameter exists in alpha."
      },
      "delay": {
        "type": "number",
        "description": "The desired response delay, in milliseconds.  This parameter exists in alpha."
      },
      "triggerError": {
        "type": "boolean",
        "description": "If `true`, returns an HTTP `4xx` error that contains the string in `message`.  This parameter exists in alpha."
      },
      "triggerMultipleErrors": {
        "type": "boolean",
        "description": "If `true`, returns an HTTP `4xx` error that contains the value of the `message` field in the error message array.  This has no effect if the request sets `triggerError`.  This parameter exists in alpha."
      },
      "triggerUnexpectedError": {
        "type": "boolean",
        "description": "If `true`, triggers a `500` error.  This has no effect if the request sets either `triggerError` or `triggerMultipleErrors`.  This parameter exists in alpha."
      },
      "statusCode": {
        "type": "number",
        "description": "Sets the HTTP status code to return.  This parameter exists in alpha."
      }
    },
    "required": [
      "PCID",
      "message"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_get\_events\_volume\_from\_workspace

Get Events Volume from Workspace

**Parameters:**

| Parameter     | Type      | Required | Default | Description                                                                                                                                                                                                                                                  |
| ------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `granularity` | string    | Yes      | —       | The size of each bucket in the requested window.  This parameter exists in v1.                                                                                                                                                                               |
| `startTime`   | string    | Yes      | —       | The ISO8601 formatted timestamp that corresponds to the beginning of the requested time frame, inclusive.  This parameter exists in v1.                                                                                                                      |
| `endTime`     | string    | Yes      | —       | The ISO8601 formatted timestamp that corresponds to the end of the requested time frame, noninclusive. Segment recommends that you lag queries 1 minute behind clock time to reduce the risk for latency to impact the counts.  This parameter exists in v1. |
| `groupBy`     | string\[] | No       | —       | A comma-delimited list of strings that represents the dimensions to group the result by. The options are: `eventName`, `eventType` and `source`.  This parameter exists in v1.                                                                               |
| `sourceId`    | string\[] | No       | —       | A list of strings which filters the results to the given SourceIds.  This parameter exists in v1.                                                                                                                                                            |
| `eventName`   | string\[] | No       | —       | A list of strings which filters the results to the given EventNames.  This parameter exists in v1.                                                                                                                                                           |
| `eventType`   | string\[] | No       | —       | A list of strings which filters the results to the given EventTypes.  This parameter exists in v1.                                                                                                                                                           |
| `appVersion`  | string\[] | No       | —       | A list of strings which filters the results to the given AppVersions.  This parameter exists in v1.                                                                                                                                                          |
| `pagination`  | object    | No       | —       | Pagination input for event volume by Workspace.  This parameter exists in v1.                                                                                                                                                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "granularity": {
        "type": "string",
        "description": "The size of each bucket in the requested window.  This parameter exists in v1.",
        "enum": [
          "DAY",
          "HOUR",
          "MINUTE"
        ]
      },
      "startTime": {
        "type": "string",
        "description": "The ISO8601 formatted timestamp that corresponds to the beginning of the requested time frame, inclusive.  This parameter exists in v1."
      },
      "endTime": {
        "type": "string",
        "description": "The ISO8601 formatted timestamp that corresponds to the end of the requested time frame, noninclusive. Segment recommends that you lag queries 1 minute behind clock time to reduce the risk for latency to impact the counts.  This parameter exists in v1."
      },
      "groupBy": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A comma-delimited list of strings that represents the dimensions to group the result by. The options are: `eventName`, `eventType` and `source`.  This parameter exists in v1."
      },
      "sourceId": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of strings which filters the results to the given SourceIds.  This parameter exists in v1."
      },
      "eventName": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of strings which filters the results to the given EventNames.  This parameter exists in v1."
      },
      "eventType": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of strings which filters the results to the given EventTypes.  This parameter exists in v1."
      },
      "appVersion": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "A list of strings which filters the results to the given AppVersions.  This parameter exists in v1."
      },
      "pagination": {
        "type": "object",
        "description": "Pagination input for event volume by Workspace.  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",
      "granularity",
      "startTime",
      "endTime"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_get\_plan

Get Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      }
    },
    "required": [
      "PCID",
      "trackingPlanId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_get\_transformation

Get Transformation

**Parameters:**

| Parameter          | Type   | Required | Default | Description       |
| ------------------ | ------ | -------- | ------- | ----------------- |
| `transformationId` | string | Yes      | —       | Transformation Id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "transformationId": {
        "type": "string",
        "description": "Transformation Id"
      }
    },
    "required": [
      "PCID",
      "transformationId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_list\_rules\_from\_tracking\_plan

List Rules from Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                       |
| ---------------- | ------ | -------- | ------- | ------------------------------------------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id                                  |
| `pagination`     | object | No       | —       | Pagination options.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan 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",
      "trackingPlanId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_list\_sources\_from\_tracking\_plan

List Sources from Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                       |
| ---------------- | ------ | -------- | ------- | ------------------------------------------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id                                  |
| `pagination`     | object | No       | —       | Pagination options.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan 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",
      "trackingPlanId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_list\_tracking\_plans

List Tracking Plans

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                                                           |
| ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `type`       | string | No       | —       | Requests Tracking Plans of a certain type. If omitted, lists all types.  This parameter exists in v1. |
| `pagination` | object | No       | —       | Pagination options.  This parameter exists in v1.                                                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "type": {
        "type": "string",
        "description": "Requests Tracking Plans of a certain type. If omitted, lists all types.  This parameter exists in v1.",
        "enum": [
          "ENGAGE",
          "LIVE",
          "PROPERTY_LIBRARY",
          "RULE_LIBRARY",
          "TEMPLATE"
        ]
      },
      "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"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_list\_transformations

List Transformations

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                       |
| ------------ | ------ | -------- | ------- | ------------------------------------------------- |
| `pagination` | object | No       | —       | Pagination options.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "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"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_remove\_rules\_from\_tracking\_plan

Remove Rules from Tracking Plan

**Parameters:**

| Parameter        | Type      | Required | Default | Description                                    |
| ---------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `trackingPlanId` | string    | Yes      | —       | Tracking Plan Id                               |
| `rules`          | object\[] | Yes      | —       | Rules to delete.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      },
      "rules": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "COMMON",
                "GROUP",
                "IDENTIFY",
                "PAGE",
                "SCREEN",
                "TRACK"
              ],
              "description": "The type for this Tracking Plan rule."
            },
            "key": {
              "type": "string",
              "description": "Key to this rule (free-form string like 'Button clicked')."
            },
            "version": {
              "type": "number",
              "description": "Version of this rule."
            }
          },
          "required": [
            "type",
            "version"
          ]
        },
        "description": "Rules to delete.  This parameter exists in v1."
      }
    },
    "required": [
      "PCID",
      "trackingPlanId",
      "rules"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_remove\_source\_from\_tracking\_plan

Remove Source from Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                                                                                        |
| ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id                                                                                                                   |
| `sourceId`       | string | Yes      | —       | The id of the Source associated with the Tracking Plan.  Config API note: analogous to `sourceName`.  This parameter exists in v1. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      },
      "sourceId": {
        "type": "string",
        "description": "The id of the Source associated with the Tracking Plan.  Config API note: analogous to `sourceName`.  This parameter exists in v1."
      }
    },
    "required": [
      "PCID",
      "trackingPlanId",
      "sourceId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_replace\_rules\_in\_tracking\_plan

Replace Rules in Tracking Plan

**Parameters:**

| Parameter        | Type      | Required | Default | Description       |
| ---------------- | --------- | -------- | ------- | ----------------- |
| `trackingPlanId` | string    | Yes      | —       | Tracking Plan Id  |
| `rules`          | object\[] | Yes      | —       | Rules to replace. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      },
      "rules": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "COMMON",
                "GROUP",
                "IDENTIFY",
                "PAGE",
                "SCREEN",
                "TRACK"
              ],
              "description": "The type for this Tracking Plan rule."
            },
            "key": {
              "type": "string",
              "description": "Key to this rule (free-form string like 'Button clicked')."
            },
            "jsonSchema": {
              "description": "JSON Schema of this rule."
            },
            "version": {
              "type": "number",
              "description": "Version of this rule."
            }
          },
          "required": [
            "jsonSchema",
            "type",
            "version"
          ]
        },
        "description": "Rules to replace."
      }
    },
    "required": [
      "PCID",
      "trackingPlanId",
      "rules"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_update\_rules\_in\_tracking\_plan

Update Rules in Tracking Plan

**Parameters:**

| Parameter        | Type      | Required | Default | Description                |
| ---------------- | --------- | -------- | ------- | -------------------------- |
| `trackingPlanId` | string    | Yes      | —       | Tracking Plan Id           |
| `rules`          | object\[] | No       | —       | Rules to update or insert. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      },
      "rules": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "newKey": {
              "type": "string",
              "description": "This rule's new intended key."
            },
            "type": {
              "type": "string",
              "enum": [
                "COMMON",
                "GROUP",
                "IDENTIFY",
                "PAGE",
                "SCREEN",
                "TRACK"
              ],
              "description": "The type for this Tracking Plan rule."
            },
            "key": {
              "type": "string",
              "description": "Key to this rule (free-form string like 'Button clicked')."
            },
            "jsonSchema": {
              "description": "JSON Schema of this rule."
            },
            "version": {
              "type": "number",
              "description": "Version of this rule."
            }
          },
          "required": [
            "jsonSchema",
            "type",
            "version"
          ]
        },
        "description": "Rules to update or insert."
      }
    },
    "required": [
      "PCID",
      "trackingPlanId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_update\_tracking\_plan

Update Tracking Plan

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                         |
| ---------------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `trackingPlanId` | string | Yes      | —       | Tracking Plan Id                                                    |
| `description`    | string | No       | —       | The Tracking Plan's description.                                    |
| `name`           | string | No       | —       | The Tracking Plan's name.  Config API note: equal to `displayName`. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "trackingPlanId": {
        "type": "string",
        "description": "Tracking Plan Id"
      },
      "description": {
        "type": "string",
        "description": "The Tracking Plan's description."
      },
      "name": {
        "type": "string",
        "description": "The Tracking Plan's name.  Config API note: equal to `displayName`."
      }
    },
    "required": [
      "PCID",
      "trackingPlanId"
    ]
  }
  ```
</Expandable>

***

## segment\_tracking\_update\_transformation

Update Transformation

**Parameters:**

| Parameter                      | Type      | Required | Default | Description                                                                                                                                                                                                                                  |
| ------------------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transformationId`             | string    | Yes      | —       | Transformation Id                                                                                                                                                                                                                            |
| `allowProperties`              | string\[] | No       | —       | Optional array for allowing properties from your events.                                                                                                                                                                                     |
| `destinationMetadataId`        | string    | No       | —       | The optional Destination metadata to be associated with the Transformation.                                                                                                                                                                  |
| `drop`                         | boolean   | No       | —       | Optional boolean value if the Transformation should drop the event entirely when the if statement matches, ignores all other transforms.                                                                                                     |
| `enabled`                      | boolean   | No       | —       | If the Transformation should be enabled.                                                                                                                                                                                                     |
| `fqlDefinedProperties`         | object\[] | No       | —       | Optional array for updating properties defined in [FQL](https://segment.com/docs/config-api/fql/). Currently limited to 1 property.                                                                                                          |
| `hashPropertiesConfiguration`  | object    | No       | —       | Optional object for hashing properties within an event.                                                                                                                                                                                      |
| `if`                           | string    | No       | —       | If statement ([FQL](https://segment.com/docs/config-api/fql/)) to match events.  For standard event matchers, use the following:  Track -\&gt; "event='\&lt;eventName\&gt;'"  Identify -\&gt; "type='identify'"  Group -\&gt; "type='group'" |
| `name`                         | string    | No       | —       | The name of the Transformation.                                                                                                                                                                                                              |
| `newEventName`                 | string    | No       | —       | Optional new event name for renaming events. Works only for 'track' event type.                                                                                                                                                              |
| `propertyRenames`              | object\[] | No       | —       | Optional array for renaming properties collected by your events.                                                                                                                                                                             |
| `propertyValueTransformations` | object\[] | No       | —       | Optional array for transforming properties and values collected by your events. Limited to 10 properties.                                                                                                                                    |
| `sourceId`                     | string    | No       | —       | The optional Source to be associated with the Transformation.                                                                                                                                                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "transformationId": {
        "type": "string",
        "description": "Transformation Id"
      },
      "allowProperties": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Optional array for allowing properties from your events."
      },
      "destinationMetadataId": {
        "type": "string",
        "description": "The optional Destination metadata to be associated with the Transformation."
      },
      "drop": {
        "type": "boolean",
        "description": "Optional boolean value if the Transformation should drop the event entirely when the if statement matches, ignores all other transforms."
      },
      "enabled": {
        "type": "boolean",
        "description": "If the Transformation should be enabled."
      },
      "fqlDefinedProperties": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "fql": {
              "type": "string",
              "description": "The FQL expression used to compute the property."
            },
            "propertyName": {
              "type": "string",
              "description": "The new property name."
            }
          },
          "required": [
            "fql",
            "propertyName"
          ]
        },
        "description": "Optional array for updating properties defined in [FQL](https://segment.com/docs/config-api/fql/). Currently limited to 1 property."
      },
      "hashPropertiesConfiguration": {
        "description": "Optional object for hashing properties within an event."
      },
      "if": {
        "type": "string",
        "description": "If statement ([FQL](https://segment.com/docs/config-api/fql/)) to match events.  For standard event matchers, use the following:  Track -\\> \"event='\\<eventName\\>'\"  Identify -\\> \"type='identify'\"  Group -\\> \"type='group'\""
      },
      "name": {
        "type": "string",
        "description": "The name of the Transformation."
      },
      "newEventName": {
        "type": "string",
        "description": "Optional new event name for renaming events. Works only for 'track' event type."
      },
      "propertyRenames": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "oldName": {
              "type": "string",
              "description": "The old name of the property."
            },
            "newName": {
              "type": "string",
              "description": "The new name to rename the property."
            }
          },
          "required": [
            "newName",
            "oldName"
          ]
        },
        "description": "Optional array for renaming properties collected by your events."
      },
      "propertyValueTransformations": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "propertyPaths": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The property paths. The maximum number of paths is 10."
            },
            "propertyValue": {
              "type": "string",
              "description": "The new value of the property paths."
            }
          },
          "required": [
            "propertyPaths",
            "propertyValue"
          ]
        },
        "description": "Optional array for transforming properties and values collected by your events. Limited to 10 properties."
      },
      "sourceId": {
        "type": "string",
        "description": "The optional Source to be associated with the Transformation."
      }
    },
    "required": [
      "PCID",
      "transformationId"
    ]
  }
  ```
</Expandable>