You can use the API to get or set label information.
The API tag is used to implement internationalization and multilingual for the widget and chatbots.
| Field | Type | Description |
|---|
id | String | The unique identifier for the label which is given by Pingstreams. |
data | Object | The label data model. |
attributes | Object | The custom attributes which are set for the label. |
createdAt | String | The time (ISO-8601 date string) when the label was created. |
updatedAt | String | The time (ISO-8601 date string) when the label was updated. |
createdBy | String | The unique identifier of the row creator |
id_project | String | The unique identifier of the project |
| Field | Type | Description |
|---|
lang | String | The language identifier |
data | Object | The translation labels data |
category | String | The label data category |
default | Boolean | Determines if this translation is the default for the project. |
GET https://api.pingstreams.com/v3/:project_id/labels
Allows an account to list all the labels.
| Parameter | Type | Description |
|---|
project_id | string | the Project Id is a unique code assigned to your project when you create it in Pingstreams. |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
curl -v -X GET -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels
GET https://api.pingstreams.com/v3/:project_id/labels/:id
Fetches the labels by the provided language
| Parameter | Type | Description |
|---|
id | string | the language iso identifier(Ex. EN, IT, ES, etc.) |
project_id | string | The project_id is a unique code assigned to your project when you create it in Pingstreams |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
Content-Type | string | use “application/json” value |
curl -v -X GET -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/EN
POST https://api.pingstreams.com/v3/:project_id/labels
Allows to add or update labels.
| Parameter | Type | Description |
|---|
project_id | string | The project_id is a unique code assigned to your project when you create it in Pingstreams |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
Content-Type | string | use “application/json” value |
| Field | Type | Description |
|---|
lang | string | the language identifier |
data | object | the data object |
default | boolean | Dermine if this is the default language |
curl -v -X POST -H 'Content-Type: application/json' -u user@example.com:123456 -d '{"lang":"andrea", "data":{OBJECT}}' https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels
PATCH https://api.pingstreams.com/v3/:project_id/labels/:lang/default
Make a language as default for the project
| Parameter | Type | Description |
|---|
project_id | string | The project_id is a unique code assigned to your project when you create it in Pingstreams |
lang | string | The language identifier |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
Content-Type | string | use “application/json” value |
curl -v -X PATCH -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/EN/default
DELETE https://api.pingstreams.com/v3/:project_id/labels/:lang
Allows to delete a label by language identifier.
| Parameter | Type | Description |
|---|
project_id | string | The project_id is a unique code assigned to your project when you create it in Pingstreams |
lang | string | The lang indentifier. |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
curl -v -X DELETE -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/EN
DELETE https://api.pingstreams.com/v3/:project_id/labels/
Allows to delete all the labels of the project
| Parameter | Type | Description |
|---|
project_id | string | The project_id is a unique code assigned to your project when you create it in Pingstreams |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
curl -v -X DELETE -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/
GET https://api.pingstreams.com/v3/:project_id/labels/default
| Parameter | Type | Description |
|---|
project_id | string | the Project Id is a unique code assigned to your project when you create it in Pingstreams. |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
curl -v -X GET -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/default
GET https://api.pingstreams.com/v3/:project_id/labels/default/lang
| Parameter | Type | Description |
|---|
project_id | string | the Project Id is a unique code assigned to your project when you create it in Pingstreams. |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
curl -v -X GET -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/default/EN
POST https://api.pingstreams.com/v3/:project_id/labels/default/clone
| Parameter | Type | Description |
|---|
project_id | string | The project_id is a unique code assigned to your project when you create it in Pingstreams |
| Header | Type | Description |
|---|
Authorization | string | authorization token. Basic Auth or JWT |
Content-Type | string | use “application/json” value |
| Field | Type | Description |
|---|
lang | string | the language identifier |
curl -v -X POST -H 'Content-Type: application/json' -u user@example.com:123456 https://api.pingstreams.com/v3/5b55e806c93dde00143163dd/labels/default/clone
