Get Metadata

GET 
/api/v1/metadata/:namespace/:uid

Get Metadata

Request

Path Parameters

namespace stringrequired

Possible values: [analytics, inspection]

The logical type of data that is set by Inspectorio

uid stringrequired

UIDs (unique identifiers) are unique within Ecosystem + Namespace. You can consider it as a Unique Keys of ecosystem + namespace + uid

Responses

200

OK

application/json

Schema

Schema

data

object

Metadata

createdDate date-time

Creation date of the metadata

items

object[]

required

Possible values: >= 1, <= 150

Metadata items

Array [

object

]

uid stringrequired

Possible values: non-empty and <= 100 characters

Unique identifier of a Metadata.

updatedDate date-time

Last updated date of the metadata

Example (from schema)

{
  "data": {
    "createdDate": "2021-06-03T04:02:57.849000+00:00",
    "items": [
      {
        "key": "test_key",
        "type": "string",
        "value": "The value of test_key"
      },
      {
        "key": "test_key",
        "type": "number",
        "value": 2021
      },
      {
        "key": "test_key",
        "type": "boolean",
        "value": false
      },
      {
        "key": "test_key",
        "type": "date",
        "value": "2020-09-30"
      },
      {
        "key": "test_key",
        "type": "datetime",
        "value": "2020-09-30T09:09:09Z"
      },
      {
        "key": "test_key",
        "type": "string-array",
        "value": [
          "string"
        ]
      },
      {
        "key": "test_key",
        "type": "number-array",
        "value": [
          0
        ]
      },
      {
        "key": "test_key",
        "type": "date-array",
        "value": [
          "2024-09-09"
        ]
      },
      {
        "key": "test_key",
        "type": "datetime-array",
        "value": [
          "2024-09-09T01:11:01.457Z"
        ]
      },
      {
        "key": "test_key",
        "type": "boolean-array",
        "value": [
          true
        ]
      },
      {
        "key": "test_key",
        "type": "file",
        "value": "https://files.stg.inspectorio.com/sight/589/7712/9b02e83f-a28b-40a1-acd0-0863a5489074.jpg"
      },
      {
        "key": "test_key",
        "type": "object",
        "value": [
          {
            "key": "test_key",
            "type": "string",
            "value": "The value of test_key"
          },
          {
            "key": "test_key",
            "type": "number",
            "value": 2021
          },
          {
            "key": "test_key",
            "type": "boolean",
            "value": false
          },
          {
            "key": "test_key",
            "type": "date",
            "value": "2020-09-30"
          },
          {
            "key": "test_key",
            "type": "datetime",
            "value": "2020-09-30T09:09:09Z"
          },
          {
            "key": "test_key",
            "type": "string-array",
            "value": [
              "string"
            ]
          },
          {
            "key": "test_key",
            "type": "number-array",
            "value": [
              0
            ]
          },
          {
            "key": "test_key",
            "type": "date-array",
            "value": [
              "2024-09-09"
            ]
          },
          {
            "key": "test_key",
            "type": "datetime-array",
            "value": [
              "2024-09-09T01:11:01.459Z"
            ]
          },
          {
            "key": "test_key",
            "type": "boolean-array",
            "value": [
              true
            ]
          },
          {
            "key": "test_key",
            "type": "file",
            "value": "https://files.stg.inspectorio.com/sight/589/7712/9b02e83f-a28b-40a1-acd0-0863a5489074.jpg"
          }
        ]
      },
      {
        "key": "test_key",
        "type": "object-array",
        "value": [
          [
            {
              "key": "test_key",
              "type": "string",
              "value": "The value of test_key"
            },
            {
              "key": "test_key",
              "type": "number",
              "value": 2021
            },
            {
              "key": "test_key",
              "type": "boolean",
              "value": false
            },
            {
              "key": "test_key",
              "type": "date",
              "value": "2020-09-30"
            },
            {
              "key": "test_key",
              "type": "datetime",
              "value": "2020-09-30T09:09:09Z"
            },
            {
              "key": "test_key",
              "type": "string-array",
              "value": [
                "string"
              ]
            },
            {
              "key": "test_key",
              "type": "number-array",
              "value": [
                0
              ]
            },
            {
              "key": "test_key",
              "type": "date-array",
              "value": [
                "2024-09-09"
              ]
            },
            {
              "key": "test_key",
              "type": "datetime-array",
              "value": [
                "2024-09-09T01:11:01.460Z"
              ]
            },
            {
              "key": "test_key",
              "type": "boolean-array",
              "value": [
                true
              ]
            },
            {
              "key": "test_key",
              "type": "file",
              "value": "https://files.stg.inspectorio.com/sight/589/7712/9b02e83f-a28b-40a1-acd0-0863a5489074.jpg"
            }
          ]
        ]
      }
    ],
    "uid": "374b5abc9dcb",
    "updatedDate": "2021-06-03T04:02:57.849000+00:00"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...