You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment Config API omitted fields: -`attributes`, -`userAgent` Rate limit headers (tracked separately for internal vs external regulation types): - X-Regulation-RateLimit-Remaining: Remaining requests for the regulation type category (string field integer) - Internal types: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - External types: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-Regulation-RateLimit-Quota-Reset: ISO 8601 timestamp for when the quota resets (for example, 2024-12-31T23:59:59.000Z)
24
+
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment Config API omitted fields: -`attributes`, -`userAgent` Rate limit headers (tracked separately for internal vs external regulation types): - X-Regulation-RateLimit-Remaining: Remaining requests for the regulation type category (integer as string) - Internal types: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - External types: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-Regulation-RateLimit-Quota-Reset: ISO 8601 timestamp for when the quota resets (for example, 2024-12-31T23:59:59.000Z)
25
25
26
26
###Example
27
27
@@ -97,7 +97,7 @@ Name | Type | Description | Notes
97
97
98
98
Create Source Regulation
99
99
100
-
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment • When called, this endpoint may generate the`Source Regulation Created` event in the[audit trail](/tag/Audit-Trail). Config API omitted fields: -`attributes`, -`userAgent` Rate limit headers (tracked separately for internal vs external regulation types): - X-Regulation-RateLimit-Remaining: Remaining requests for the regulation type category (string field integer) - Internal types: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - External types: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-Regulation-RateLimit-Quota-Reset: ISO 8601 timestamp for when the quota resets (for example, 2024-12-31T23:59:59.000Z)
100
+
Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment • When called, this endpoint may generate the`Source Regulation Created` event in the[audit trail](/tag/Audit-Trail). Config API omitted fields: -`attributes`, -`userAgent` Rate limit headers (tracked separately for internal vs external regulation types): - X-Regulation-RateLimit-Remaining: Remaining requests for the regulation type category (integer as string) - Internal types: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - External types: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-Regulation-RateLimit-Quota-Reset: ISO 8601 timestamp for when the quota resets (for example, 2024-12-31T23:59:59.000Z)
101
101
102
102
###Example
103
103
@@ -173,7 +173,7 @@ Name | Type | Description | Notes
173
173
174
174
Create Workspace Regulation
175
175
176
-
Creates a Workspace-scoped regulation. • When called, this endpoint may generate the`Workspace Regulation Created` event in the[audit trail](/tag/Audit-Trail). Config API omitted fields: -`attributes`, -`userAgent` Rate limit headers (tracked separately for internal vs external regulation types): - X-Regulation-RateLimit-Remaining: Remaining requests for the regulation type category (string field integer) - Internal types: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - External types: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-Regulation-RateLimit-Quota-Reset: ISO 8601 timestamp for when the quota resets (for example, 2024-12-31T23:59:59.000Z)
176
+
Creates a Workspace-scoped regulation. • When called, this endpoint may generate the`Workspace Regulation Created` event in the[audit trail](/tag/Audit-Trail). Config API omitted fields: -`attributes`, -`userAgent` Rate limit headers (tracked separately for internal vs external regulation types): - X-Regulation-RateLimit-Remaining: Remaining requests for the regulation type category (integer as string) - Internal types: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - External types: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-Regulation-RateLimit-Quota-Reset: ISO 8601 timestamp for when the quota resets (for example, 2024-12-31T23:59:59.000Z)
Copy file name to clipboardExpand all lines: segment_public_api/__init__.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@
7
7
8
8
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
9
9
10
-
The version of the OpenAPI document:62.0.0
10
+
The version of the OpenAPI document:61.0.0
11
11
Contact: friends@segment.com
12
12
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/activations_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/api_calls_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/audiences_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/audit_trail_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/catalog_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/computed_traits_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)
Copy file name to clipboardExpand all lines: segment_public_api/api/customer_insights_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
7
7
8
-
The version of the OpenAPI document:62.0.0
8
+
The version of the OpenAPI document:61.0.0
9
9
Contact: friends@segment.com
10
10
Generated by OpenAPI Generator (https://openapi-generator.tech)