Tags¶

Retrieve Tags List¶

GET /_config/tags/_list¶

Description Retrieve the list of tags associated with a specific monitor.

HTTP Method GET

Endpoint /_config/tags/_list

Request Header Authorization Basic <token>

Request Parameters

Query Parameters

monitor_id (string, optional): The ID of the monitor for which you want to retrieve the list of tags.

asset_id (string, optional): The ID of the asset for which you want to retrieve the list of tags.

Sample Request

curl --location 'https://app.4pointx.com/_config/tags/_list?monitor_id=0284f035-2647-4316-9aca-c4a26d442221' \
     --header 'Authorization: Basic <token>' \
     --data ''

Sample Response

Success

If monitor type is Condition

[
  {
      "tag_unit": "",
      "tag_id": "velocity_x_0284f035-2647-4316-9aca-c4a26d442221",
      "tag_name": "velocity_x",
      "tag_desc": "",
      "thresholds": {
        "operational": "0.5",
        "warning": "11.5",
        "caution": "4.5"
    }
  },
  {
      "tag_unit": "",
      "tag_id": "velocity_y_0284f035-2647-4316-9aca-c4a26d442221",
      "tag_name": "velocity_y",
      "tag_desc": "",
      "thresholds": {
        "operational": "0.5",
        "warning": "11.5",
        "caution": "4.5"
    }
  },
  {
      "tag_unit": "",
      "tag_id": "velocity_z_0284f035-2647-4316-9aca-c4a26d442221",
      "tag_name": "velocity_z",
      "tag_desc": "",
      "thresholds": {
        "operational": "0.5",
        "warning": "11.5",
        "caution": "4.5"
    }
  }
]

for other monitor types

[
  {
      "tag_unit": "",
      "tag_id": "velocity_x_0284f035-2647-4316-9aca-c4a26d442221",
      "tag_name": "velocity_x",
      "tag_desc": ""
  },
  {
      "tag_unit": "",
      "tag_id": "velocity_y_0284f035-2647-4316-9aca-c4a26d442221",
      "tag_name": "velocity_y",
      "tag_desc": ""
  },
  {
      "tag_unit": "",
      "tag_id": "velocity_z_0284f035-2647-4316-9aca-c4a26d442221",
      "tag_name": "velocity_z",
      "tag_desc": ""
  }
]

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
    "status": 400,
    "message":  "No tags found for monitor_id: 4f035-26298347-4316-9aca-c4a21"
  }
}

{
  "error": {
    "status": 400,
    "message":  "No tags found for asset_id: 547618d4-c481-48e5-b2a0-ae810a94883a"
  }
}

Retrieve Tags Count¶

GET /_config/tags/_count¶

Description Retrieve the total count of tags for functions and pipelines.

HTTP Method GET

Endpoint /_config/tags/_count

Request Header Authorization Basic <token>

Request Parameters

Query Parameters

pipeline_id (string, optional): The ID of the pipeline for which you want to retrieve the total tag count.

function_id (string, optional): The ID of the function for which you want to retrieve the total tag count.

Sample Request

curl --location 'https://app.4pointx.com/_config/tags/_count?function_id=3626c23b-2070-48bb-baaa-1170a39c0f88' \
     --header 'Authorization: Basic <token>' \
     --data ''

Sample Response

Success

"71.0"

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
    "status": 400,
    "message":  "Insufficient Inputs"
  }
}

{
  "error": {
    "status": 400,
    "message": "Excess Inputs"
  }
}

Query Tags Trend¶

POST /_config/tags/_trend¶

Description Query the tag trend data over a specified time range.

HTTP Method POST

Endpoint /_config/tags/_trend

Request Header Authorization Basic <token>

Request Parameters

Query Parameters

from (string, required): The start time for the trend data.

to (string, required): The end time for the trend data.

agg_func (string, optional): The aggregation function to apply to tag values (default: “avg”)(values: sum, count, max, min, etc).

agg_interval (string, required): The aggregation interval for trend data(Values: in days, months, years).

monitor_id (string, optional): The ID of the monitor for which you want to retrieve the trend data.

Body Parameters

tags (string, optional): A comma-separated list of tag IDs for which you want to retrieve the trend data.

Sample Request

Case 1: Request using monitor_id as URL parameter

curl --location 'https://app.4pointx.com//_config/tags/_trend?from=2024-05-16T11:56:36.321Z&to=2024-05-23T11:56:36.321Z&agg_func=avg&agg_interval=10m&monitor_id=0a122440-985a-4a4a-b9e8-b2108fa086f2' \
    --header 'Authorization: Basic <token>' \
    --data '{}'

Case 2: Request using tags as body parameter

curl --location 'https://app.4pointx.com//_config/tags/_trend?from=2024-05-16T11:56:36.321Z&to=2024-05-23T11:56:36.321Z&agg_func=avg&agg_interval=10m' \
    --header 'Authorization: Basic <token>' \
    --data '{
              "tags": ["acceleration_x_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "acceleration_y_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "acceleration_z_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "displacement_x_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "displacement_y_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "displacement_z_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "temperature_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "velocity_x_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "velocity_y_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "velocity_z_09689c6b-10f9-49d9-bba8-5c53a1686bf0",
                        "acceleration_x_0a122440-985a-4a4a-b9e8-b2108fa086f2"]
              }'

Sample Response

Success

[
  {
    "timestamp": "2024-05-23T09:30:00.000Z",
    "acceleration_x_09689c6b-10f9-49d9-bba8-5c53a1686bf0": 377.41913561551075,
    "acceleration_x_0a122440-985a-4a4a-b9e8-b2108fa086f2": 435.29252250239534,
    "acceleration_x_227a8961-43b8-487a-a481-909e5653305b": 378.2721168949919,
    "acceleration_x_50e09aed-aeab-428d-bb9a-549fbb1ccd34": 400.27624626879424,
    "acceleration_x_6e395e07-cbb5-48dd-93f8-b14867106044": 381.3254570151275,
    "acceleration_x_c910c7a0-64a5-49f7-be12-07e5ff192bbe": 434.5962147262861,
    "acceleration_x_d7acc17c-6a35-4986-afce-7c64ea0877ad": 399.9745633107311,
    "acceleration_x_dd33191a-4fee-44a2-b121-685c414db2fc": 409.2890699854437,
    "acceleration_x_e3bf8ce2-87c8-4691-9fb4-1f7ee33171a4": 402.9165139828088,
    "acceleration_x_fccdc988-da05-46d2-8f38-4a2a3cc8eda6": 425.60913431419516
  },
  {
    "timestamp": "2024-05-23T09:40:00.000Z",
    "acceleration_x_0441d9ad-be0a-4fd4-84cb-dcf91cbb146c": 392.14057741326803,
    "acceleration_x_05c6218a-2613-46b8-b078-f0692f0c20eb": 406.845869678562,
    "acceleration_x_09689c6b-10f9-49d9-bba8-5c53a1686bf0": 396.3273116289559,
    "acceleration_x_0a122440-985a-4a4a-b9e8-b2108fa086f2": 395.647922580525,
    "acceleration_x_10770497-a8a3-422c-96c4-fc98cccfd49b": 396.3469284833488,
    "acceleration_x_185acef8-da46-4320-85e2-9d33aeafb79c": 387.1515081373312,
    "acceleration_x_1a237e3f-3135-4750-97f6-fb888162e9ec": 406.6904141700874,
    "acceleration_x_225e02a5-2156-435e-bde1-d8d31fc7f076": 358.4152575993942,
    "acceleration_x_226e41ea-1ac7-49fa-adee-da1b7e72c1fc": 396.6618610963983,
    "acceleration_x_227a8961-43b8-487a-a481-909e5653305b": 377.41961540610106
  }
]

Error

{
  "error": {
    "status": 401,
    "message": "Unauthorized access to module by general-user"
  }
}

{
  "error": {
    "status": 400,
    "message":  "Insufficient Inputs"
  }
}

{
  "error": {
    "status": 400,
    "message": "Error <message>"
  }
}