Tags

You can use the API to get or set tags.

The Tag model

Field	Type	Description
id	String	The unique identifier for the tag which is given by Pingstreams.
tag	String	The tag name.
color	String	The tag hexadecimal color
attributes	Object	The custom attributes which are set for the tag.
createdAt	String	The time (ISO-8601 date string) when the tag was created.
updatedAt	String	The time (ISO-8601 date string) when the tag was updated.
createdBy	String	The unique identifier of the row creator
id_project	String	The unique identifier of the project

Get all tags

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

Allows an account to list all the tags.

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.

Query Parameters

Parameter	Type	Description
sortField	string	what field to sort the results by. Default field is createdAt
direction	string	sort direction: 1 or -1. Return the results in ascending (1) or descending (-1) order. defaults to desc
page	number	what page of results to fetch. defaults to first page.

Headers

Header	Type	Description
Authorization	string	authorization token. Basic Auth or JWT

Response

[
{
"_id":"5e67b8bafb930c0017aa4e42",
"tag":"tag1",
"color":"#66C549",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:56:42.374Z",
"updatedAt":"2020-03-10T15:56:42.374Z",
"__v":0
},
{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}
]

Get a tag by id

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

Path Parameters

Parameter	Type	Description
id	string	the tag 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
Content-Type	string	use “application/json” value

Response

{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}

Create a new tag

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

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
Content-Type	string	use “application/json” value

Request Body

Field	Type	Description
tag	string	the tag name
color	string	the tag color
attributes	object	The tag custom attributes

Response

{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}

Update a tag by id

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

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 tag indentifier.

Headers

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

Request Body

Field	Type	Description
tag	string	the tag name
color	string	the tag color
attributes	object	The tag custom attributes

Response

{
"_id":"5e67b737fb930c0017aa4e40",
"tag":"important",
"color":"#43B1F2",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T15:50:15.759Z",
"updatedAt":"2020-03-10T15:50:15.759Z",
"__v":0
}

Delete a tag by id

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

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 tag indentifier.

Headers

Header	Type	Description
Authorization	string	authorization token. Basic Auth or JWT