Filters

Wiki ▸ API Reference ▸ Shouts ▸ Filters

Filters are objects to describe shouts in more details. They can be also used to refine search results. Each category has its own list of filters.

Category Filter

{
    "name": "Engine",
    "slug": "engine",
    "values": [
        {
            "id": "ee437201-3c86-42bc-a1b4-7bce7845c468",
            "name": "V6",
            "value": "v6"
        },
        {
            "id": "cc9de671-0709-450b-aef0-dd1f31d9893c",
            "name": "V8",
            "value": "v8"
        }
    ]
}

Shouts have also list of filters however each of those has only single value.

Shout Filter

{
    "name": "Disk Size",
    "slug": "disk-size",
    "value": {
        "id": "308106c0-b1e0-4120-85c5-f1b1e6acf87f",
        "name": "500 GB",
        "slug": "500-gb"
    }
}

• name for the filter and its value(s) are used only for display
• slug for the filter and its value(s) are used when searching shouts e.g. ?disk-size=500-gb
  • for filtering on more values a list of slugs can be concatenated with comma e.g. ?disk-size=500-gb,200-gb
• Clients should pass a list of Shout Filter objects when creating or updating shouts