Skip to main content
Version: v1

Brand Metric Groups

When BAV studies a brand it does so on a variety of metrics. These metrics are divided into groups. Each group relates to a specific way to look at a brand, or to a BAV model.

List Brand Metric Groups​

To list all of the groups and browse them via the API, use the list endpoint:

GET /api/v1/brand-metric-groups

The groups list response contains details about the group.

Schema​

KeyTypeDescription
idintegerThe system ID for the group.
namestringThe primary name of the group.
descriptionstringA short description on what this group is about.
{
    "data": [
        {
            "id": 2,
            "name": "Pillars",
            "description": "The 4 pillars \u2013 Differentiation, Relevance, Esteem, and Knowledge \u2013 make up the foundation of BAV. The patterns of the pillars for a brand explain the positioning in culture"
        },
        //...
    ]
    // ...
}

Get a Brand Metric Group​

You may also directly retrieve a group's details if you already have its system ID.

GET /api/v1/brand-metric-groups/123

Where 123 is the system ID of the group.

Schema​

KeyTypeDescription
idintegerThe system ID for the group.
namestringThe primary name of the group.
descriptionstringA short description on what this group is about.
{
    {
        "id": 2,
        "name": "Pillars",
        "description": "The 4 pillars \u2013 Differentiation, Relevance, Esteem, and Knowledge \u2013 make up the foundation of BAV. The patterns of the pillars for a brand explain the positioning in culture"
    },
}

Configurable Fields​

If you only need some of the fields you can optimize the request for a leaner response ( see Configurable Fields for more information). The following fields can be toggled:

  • name
  • description

Expansions​

To create a leaner response data related to brands are not included in the response by default. See the Expansions section for more information on how this works. The following relationships can be expanded for the brand metric groups:

  • metrics - A list of metrics that are part of this group.

Filters​

The groups endpoint supports the following filters:

Sorting​

The following fields are sortable:

  • id
  • name
  • description