# Parity Timeline

<mark style="color:blue;">`GET`</mark> `https://api.rateparity.com/v1/insights/paritytimeline/{code}`

By default the timeline period to search is 7 days (last week). Search for a custom period is also available for a maximum of 31 days.

#### Path Parameters

| Name                                   | Type   | Description       |
| -------------------------------------- | ------ | ----------------- |
| code<mark style="color:red;">\*</mark> | String | The property code |

#### Query Parameters

| Name | Type | Description                                                 |
| ---- | ---- | ----------------------------------------------------------- |
| from | Date | Search from date (ISO 8601). Defaults to today minus 7 days |
| to   | Date | Search to date (ISO 8601). Defaults to today - 1 days       |

{% tabs %}
{% tab title="200: OK Everything worked as expected" %}
{% code lineNumbers="true" %}

```json
{
    "data": [
        {
            "date": "2023-04-01",
            "visits": 1606,
            "disparities": 907,
            "conversion": 57.0
        },
        {
            "date": "2023-04-02",
            "visits": 1823,
            "disparities": 191,
            "conversion": 11.0
        },
        {
            "date": "2023-04-03",
            "visits": 1685,
            "disparities": 432,
            "conversion": 26.0
        },
        {
            "date": "2023-04-04",
            "visits": 1336,
            "disparities": 309,
            "conversion": 24.0
        }
    ],
    "summary": {
        "visits": 6450.0,
        "disparities": 1839.0,
        "conversion": 29.0
    }
}
```

{% endcode %}
{% endtab %}

{% tab title="400: Bad Request Period is more than 31 days or invalid (i.e. to date is earlier than from date)" %}

```json
{
    "timestamp": "27-04-2023 08:00:13",
    "message": "Data provided is invalid"
}
```

{% endtab %}

{% tab title="401: Unauthorized No valid API key provided or not authorised to access the provided property code" %}

{% endtab %}
{% endtabs %}

## Example

{% tabs %}
{% tab title="curl" %}

<pre><code><strong>curl 'https://api.rateparity.com/v1/insights/paritytimeline/LAURA?from=2023-03-01&#x26;to=2023-03-03' \
</strong><strong>--header 'Authorization: Bearer YOUR_API_KEY'
</strong></code></pre>

{% code lineNumbers="true" %}

```json
{
    "data": [
        {
            "date": "2023-03-01",
            "visits": 474,
            "disparities": 250,
            "conversion": 53.0
        },
        {
            "date": "2023-03-02",
            "visits": 766,
            "disparities": 239,
            "conversion": 32.0
        },
        {
            "date": "2023-03-03",
            "visits": 820,
            "disparities": 360,
            "conversion": 44.0
        }
    ],
    "summary": {
        "visits": 2060.0,
        "disparities": 849.0,
        "conversion": 42.0
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rateparity.com/insights/parity-timeline.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.