Information about all attributes

Returns information about system and custom attributes.

Request

GET

https://api-metrica.yandex.net/cdp/api/v1/counter/{counterId}/schema/attributes

Path parameters

Name

Description

counterId*

Type: integer<int32>

Counter ID.
Example: 2215573

Query parameters

Name

Description

entity_type*

Type: string

Attribute ownership.
Possible values:

CONTACT: Attributes belong to contacts.
COMPANY: Attributes belong to companies.
ORDER: Attributes belong to orders.
SIMPLE_ORDER: Attributes belong to simple orders.
Example: CONTACT

Responses

200 OK

Body

application/json

{
    "system_attributes": [
        {
            "name": "string",
            "type_name": "string",
            "type_group": "string",
            "type_humanized": "string",
            "multivalued": false,
            "humanized": "string"
        }
    ],
    "custom_attributes": [
        {
            "name": "string",
            "type_name": "string",
            "type_group": "string",
            "type_humanized": "string",
            "multivalued": false,
            "humanized": "string"
        }
    ]
}

Name

Description

custom_attributes

Type: Attribute[]

List of custom attributes.
Description of the Attribute object.

system_attributes

Type: Attribute[]

List of system attributes.
Description of the Attribute object.

Attribute

Description of the Attribute object.

Name	Description
multivalued*	Type: boolean Determines whether the attribute can have multiple values.
name*	Type: string Attribute ID. Min length: `1` Max length: `255` Pattern: `^[\w-:]+$`
humanized	Type: string Attribute name. Min length: `0` Max length: `4096`
type_group	Type: string Attribute type group. Possible values: `PREDEFINED`: Scalar attribute type. Examples of `type_name` values: `numeric`, `date`, `datetime`, `email`, and `text`. `CUSTOM_LIST`: Arbitrary attribute type. `SYSTEM_LIST`: Product list, `type_name`: `product`.
type_humanized	Type: string Attribute type name.
type_name	Type: string Attribute type ID.

Was the article helpful?

Creating a product list

Information about types of custom attributes