> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automaticrostering.visma.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Analyzer

> Analyze a roster request and present findings using your preferred phrasing.

The Analyzer checks a roster request for issues such as insufficient staffing
capacity or employees unable to work, and returns findings for your users.

## Send a request

Call `POST /reason/analyze` with the **same JSON body as `POST /roster/start`**
and your usual [authentication](/v2/getting-started/authentication). See the
[Quickstart](/v2/getting-started/quickstart) for an example payload.

Multiple languages are supported. Set the `language` query parameter to choose
the output language; English is the default.

## Display the response

The response contains `findings` and an optional `summary`, all using the
`{ text, entities }` format explained in [Basics](/v2/reasoning/basics).

```json title="Example response" theme={null}
{
  "findings": [
    {
      "text": "Over 2 weeks, shift {{0}} needs 80 hours, but employee capacity is 64 hours.",
      "entities": [{ "kind": "SHIFT_ID", "value": "night-shift" }]
    }
  ],
  "summary": {
    "text": "Available capacity is below demand.",
    "entities": []
  }
}
```

Render each finding and show the summary when present. At most 30 findings are
returned; an empty result is `{ "findings": [] }`.

## Set your preferred phrasing in the Hub

Sign in to [Analyzer settings in the Hub](https://hub.automaticrostering.visma.net/console/analyzer),
choose your integration, environment, and language, then enter your preferred
phrasing for each finding type and select **Save settings**.

Write natural examples with illustrative names and values. The Analyzer follows
your wording using the request's actual facts and entity references; you do not
need to write placeholders yourself. It uses your example in the requested
language, then your English example, then the product default.

You can also disable finding types. Settings apply across all tenants in your
integration.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.