# Backlinks

> Inspect inbound links, domains, anchors, and referring networks.

Canonical: https://docs.georanker.com/docs/seo-tools-api-backlinks

Use a Backlinks report to find who links to a domain or page, inspect the text they use or track gains and losses over time. Each report has one target and one `endpoint`. The endpoint sets the level of detail in the result.

## Choose a report

| `endpoint`            | What the report shows                                                                                              |
| --------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `summary`             | Totals for backlinks, referring domains, IPs and subnets, with domain rank and broken-link counts where available. |
| `backlinks`           | Individual source pages with anchor text, rank, follow status, broken-link status and first-seen date.             |
| `referring_domains`   | One row per linking domain, with its backlink count, rank and first-seen date.                                     |
| `anchors`             | Anchor text, the number of links using it and the number of distinct referring domains.                            |
| `history`             | Backlink and referring-domain counts over time. The viewer charts them by month.                                   |
| `timeseries_new_lost` | New and lost backlink counts by date.                                                                              |
| `competitors`         | Competing targets, their ranks and the number of link-profile intersections.                                       |
| `domain_pages`        | Pages on the target with backlink counts, referring-domain counts and broken backlinks.                            |

## Request a summary

Set `SEO_TOOLS_API_KEY` to your API key. This example uses curl and jq to request a domain summary and read it by ID. Replace `example.com` with the target domain. Use a full URL for a page-level backlink report.

```bash
API='https://seoapi.georanker.com'
BACKLINK_ID=$(curl --fail-with-body -sS "$API/api/backlinks" \
  -H "Authorization: Bearer $SEO_TOOLS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
    "target": "example.com",
    "endpoint": "summary",
    "name": "Weekly backlink baseline"
  }' | jq -er '.id')

curl --fail-with-body -sS "$API/api/backlinks/$BACKLINK_ID" \
  -H "Authorization: Bearer $SEO_TOOLS_API_KEY" | jq .
```

Only `target` and `endpoint` are required. Supply the project UUID as `campaignId` if you want to find this report later with `GET /api/projects/{projectId}/backlinks`. A successful POST returns HTTP 201 and an `id`.

## Interpret the result

The report identifies the target and endpoint and includes `providerCalled` and `hasError`. The viewer refreshes a pending report while `providerCalled` is false. Check `hasError` before processing the data. A target can also have no indexed results.

The public schema describes report metadata. For a summary, the viewer reads aggregate values directly from `data`. For the seven focused reports, it reads the rows from `data.items`. Treat fields in these result objects as optional. This illustrative summary omits unrelated metadata.

```json
{
  "target": "example.com",
  "endpoint": "summary",
  "providerCalled": true,
  "hasError": false,
  "data": {
    "backlinks": 240,
    "referring_domains": 38,
    "broken_backlinks": 4
  }
}
```

In this example, 38 different domains account for 240 backlinks. To identify individual sources, create a second report with `"endpoint": "backlinks"`. Look for `url_from` and `anchor` in its items. For a list grouped by linking site, choose `referring_domains` and read the `domain` and `backlinks` fields in each row. [Read a Backlinks report](https://docs.georanker.com/docs/backlinks). [Backlinks API reference](https://seoapi.georanker.com/api/docs#/Backlinks)

[SEO Tools API overview](https://docs.georanker.com/docs/seo-tools-api)
