Skip to main content
GET
/
attributes
Get attributes
curl --request GET \
  --url https://api-dev.narrative.io/attributes
{
  "records": [
    {
      "id": 123456789,
      "name": "price",
      "description": "The price of an order, product, or a price component. Currency field accepts ISO 4217 currency codes",
      "display_name": "Price",
      "type": "object",
      "properties": {
        "value": {
          "type": "double",
          "validations": [
            "$this.value >= 0.0"
          ]
        },
        "iso_4217_currency": {
          "type": "string",
          "enum": [
            "USD",
            "GBP",
            "JPY"
          ]
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "tags": [
        "ecommerce",
        "transaction"
      ],
      "required": [
        "value",
        "iso_4217_currency"
      ]
    }
  ]
}

Query Parameters

​
resolve
boolean

resolve attribute(s) which is true by default.

​
q
string

Free-text search term. When provided, attributes are ranked by their relevance to the search term.

​
min_score
number<double>

Optional minimum relevance score, in the half-open interval (0, 1]. By default no threshold is applied and all matches are returned, ranked by relevance. Supply min_score to restrict the results to attributes scoring at or above the given value; below-threshold attributes are then excluded from both the results and the total count. Can only be supplied together with q; supplying it without q returns 400.

Required range: x <= 1

Response

200 - application/json

OK

The response is of type string.

Example:
{
  "records": [
    {
      "id": 123456789,
      "name": "price",
      "description": "The price of an order, product, or a price component. Currency field accepts ISO 4217 currency codes",
      "display_name": "Price",
      "type": "object",
      "properties": {
        "value": {
          "type": "double",
          "validations": ["$this.value >= 0.0"]
        },
        "iso_4217_currency": {
          "type": "string",
          "enum": ["USD", "GBP", "JPY"]
        },
        "tags": {
          "type": "array",
          "items": { "type": "string" }
        }
      },
      "tags": ["ecommerce", "transaction"],
      "required": ["value", "iso_4217_currency"]
    }
  ]
}