Segments

You can use the API to get or set segment information. A segment is a collection of contacts, defined by a specific set of attributes, used to filter them in a marketing campaign. User segmentation is the process of separating leads into distinct groups, or segments, based on shared characteristics. A company might segment leads based on language preferences, product version, geographical region.

The Segment Model

Field	Type	Description
id	String	The unique identifier for the segment which is given by Pingstreams.
name	String	The segment name
match	String	all or any
createdAt	String	The time (ISO-8601 date string) when the segment was created.
filters	Array	Segment filters
createdBy	String	The unique identifier of the row creator
id_project	String	The unique identifier of the project

Get all segments

GET https://api.pingstreams.com/v3/:project_id/segments

Example

curl -v -X GET -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/segments

Get a segment by id

GET https://api.pingstreams.com/v3/:project_id/segments/:id

Fetches a segment by his or her segment ID

Path Parameters

Parameter	Type	Description
id	string	the segment identifier
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent
Content-Type	string	use “application/json” value

Example

curl -v -X GET -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/segments/5c81593adf767b0017d1aa66

Create a new segment

POST https://api.pingstreams.com/v3/:project_id/segments

Allows to add more segments.

Path Parameters

Parameter	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent
Content-Type	string	use “application/json” value

Request Body

Field	Type	Description
name	string	The segment name
match	string	The segment match type. All or Any
filters	array	The segment filters

Example:

curl -v -X POST -H 'Content-Type: application/json' -u user@example.com:123456 -d '{ "name":"segment1", "filters": [{"field":"field1","operator":"=","value":"value1"}]}' https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/segments

Update a segment by id

PUT https://api.pingstreams.com/v3/:project_id/segments/:id

Allows to update a segment.

Path Parameters

Parameter	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams
id	string	The id is the segment indentifier.

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent
Content-Type	string	use “application/json” value

Request Body

Field	Type	Description
name	string	The segment name
match	string	The segment match type. All or Any
filters	array	The segment filters

Delete a segment by id

DELETE https://api.pingstreams.com/v3/:project_id/segments/:id

Allows to delete a segment.

Path Parameters

Parameter	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams
id	string	The id is the segment indentifier.

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent