Information about types of custom attributes

Returns information about types of custom attributes for customers and orders.

Request

GET

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

Path parameters

Name

Description

counterId*

Type: integer<int32>

Counter ID.
Example: 2215573

Responses

200 OK

OK

Body

application/json
{
    "types": [
        {
            "name": "string",
            "group": "string",
            "humanized": "string"
        }
    ]
}

Name

Description

types

Type: AttributeType[]

Attribute types.

AttributeType

Name

Description

name*

Type: string

Attribute type ID.

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.

humanized

Type: string

Attribute type name.