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

# Summarize a metric trend — HTTP

> Summarize first-to-latest movement over a run window.

Summarize first-to-latest movement over a run window.

**Method:** `GET`

**Path:** `/projects/{project_id}/timeseries/trend`

Use the HTTP base for your authorized environment and an `Authorization: Bearer` header. See [authentication](/developers/guides/04-authentication) and [HTTP setup](/developers/guides/06-http-quickstart).

## Parameters

This table covers the standard read profile. It excludes internal application routes and advanced analysis controls.

| Name | Location | Type | Required | Default | Meaning |
| - | - | - | - | - | - |
| `project_id` | path | string | Yes | — | Project ID from list\_projects. Select the project in the intended workspace and environment. |
| `metric_family` | query | string | Yes | — | Select citation, mention, or sentiment history. This choice determines the permitted metric and reporting unit. |
| `metric` | query | string | No | `null` | citation accepts share or coverage; mention accepts coverage; sentiment accepts net, positive, or negative. Omission selects share, coverage, or net respectively. |
| `aggregation_level` | query | string | No | `null` | citation accepts domain or url; mention and sentiment use bundle. Omission selects domain for citation and bundle for the other families. |
| `entities` | query | string | No | `null` | JSON-encoded array. Restrict mention or sentiment history to the requested brand/entity labels. Use labels actually measured in the project. |
| `domains` | query | string | No | `null` | JSON-encoded array. Restrict citation history to selected source keys. Use returned domain names or, for URL history, exact page URLs. |
| `top_n` | query | integer | No | `6` | Series-selection limit when entities and domains are omitted. An explicit entity or source selection takes precedence; this is not the number of runs or points. Minimum 1. Maximum 200. |
| `run_ids` | query | string | No | `null` | JSON-encoded array. Select runs from this project for the history window. Omit to use the available window; inspect n\_runs and truncated in the response. |
| `filters` | query | string | No | `null` | JSON-encoded array. Select measured answers with objects containing dimension and values. Use labels from list\_dimension\_options; inspect returned warnings for filters that were not applied. |

## Request example

Set `IQRUSH_API_BASE` and `IQRUSH_ACCESS_TOKEN` through secure configuration. Replace project/run IDs and sample selections with values returned by your account. JSON objects and arrays are encoded as query strings.

```bash theme={null}
curl --fail-with-body --silent --show-error --get \
  --header "Authorization: Bearer ${IQRUSH_ACCESS_TOKEN}" \
  --header "Accept: application/json" \
  --data-urlencode metric_family=citation \
  --data-urlencode metric=share \
  --data-urlencode aggregation_level=domain \
  --data-urlencode 'domains=["colorescience.com"]' \
  "${IQRUSH_API_BASE%/}/projects/${IQRUSH_PROJECT_ID}/timeseries/trend"
```

## Read the response

Read `data.trends` for direction and change information and `data.rows` for the tabular view. Preserve the run window and units.

Treat direction and interval-overlap indicators as descriptive. They do not replace an appropriate paired change test. Do not claim significance from this summary alone.

### Fields to use

These selected fields explain the example and the result to preserve. Field presence depends on the response; this is not a complete response schema.

| Field | Meaning and use |
| - | - |
| `data.n_runs` | Runs in the reported history window. |
| `data.trends[].key` | Source or entity whose history is summarized. |
| `data.trends[].n_points` | Available observations for that series; it can differ from the run count. |
| `data.trends[].delta` | Latest minus first value in the series. Retain the returned scale; null does not mean no change. |
| `data.trends[].direction` | Returned up, down, or flat label. Direction alone does not establish a meaningful change. |
| `data.trends[].ci_overlap_first_latest` | Whether the first and latest estimate intervals overlap. This is not a confidence interval on the difference. |

Selected response fields from IQRush Dev. Lists are shortened and project/run IDs are placeholders; this is not the full response.

```json theme={null}
{
  "data_ready": true,
  "data": {
    "metric_family": "citation",
    "metric": "share",
    "n_runs": 2,
    "truncated": false,
    "trends": [
      {
        "key": "colorescience.com",
        "n_points": 2,
        "delta": -0.6798500000000001,
        "direction": "down",
        "ci_overlap_first_latest": true
      }
    ]
  }
}
```

Read the actual returned scope, counts, and interval levels before interpreting these fields.

MCP equivalent: [`get_trend_summary`](/developers/tools/get_trend_summary). Use the parameters and defaults on this page for HTTP.

## If the result is unavailable

Check HTTP status and the response’s `error` field before using data. A successful empty response does not establish a zero value. Preserve `not_available`, `not_available_reason`, `unavailable_reason`, and `linked` where returned. [Errors and recovery](/developers/guides/13-errors) shows observed examples.


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