SymetryML Documentation
Encoders

Get encoder key values

Get the raw key/value/count/sum rows an Encoder holds for one categorical key (the attribute name, not one of its values) — the finer-grained, per-value data that [Get encoder statistics](/docs/api-reference/encoders/encoders-encodername-stats-get) aggregates into per-key statistics. Compare/pair with [Bulk-create encoder key values](/docs/api-reference/encoders/encoders-encodername-createkeyvalues-post) (bulk insert) and [Overwrite encoder key values](/docs/api-reference/encoders/encoders-encodername-keyvals-key-setvalues-post) (overwrite) below.

GET
/{user}/encoders/{encodername}/keyvals/{key}

Get the raw key/value/count/sum rows an Encoder holds for one categorical key (the attribute name, not one of its values) — the finer-grained, per-value data that Get encoder statistics aggregates into per-key statistics. Compare/pair with Bulk-create encoder key values (bulk insert) and Overwrite encoder key values (overwrite) below.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

encodername*string
key*string

The categorical attribute (key) name, not one of its values.

Response Body

application/json

application/json

curl -X GET "https://example.com/c1/encoders/superenc0/keyvals/device_country"
{  "statusCode": 200,  "statusString": "OK",  "values": {    "dataframe": {      "attributeNames": [        "Value",        "Type",        "Count",        "Sum"      ],      "data": [        [          "ca",          "s",          "123",          "45.0"        ],        [          "us",          "s",          "456",          "7.0"        ]      ],      "errorHandling": 1    }  }}
{  "statusCode": 400,  "statusString": "Cannot Find Encoder[nosuchenc] for Customer[c1].",  "values": {}}