Get top referral sources | GitHub API (unofficial showcase)

2 parameters

ownerstringrequired

The account owner of the repository; the name is not case-sensitive.

repostringrequired

The repository name without the `.git` extension; the name is not case-sensitive.

2 status codes

200Returns an array of referral source objects, each containing the referrer name, visit count, and unique visitor count.

referrerstringrequired

countintegerrequired

uniquesintegerrequired

403Returned when the authenticated user is not permitted to access repository traffic data.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned when the authenticated user cannot access traffic data for the repository. The owner and repo path parameters must identify the repository.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.referrers.list({
  owner: "octocat",
  repo: "hello-world",
});

[
  {
    "referrer": "Google",
    "count": 4,
    "uniques": 3
  },
  {
    "referrer": "stackoverflow.com",
    "count": 2,
    "uniques": 2
  },
  {
    "referrer": "eggsonbread.com",
    "count": 1,
    "uniques": 1
  },
  {
    "referrer": "yandex.ru",
    "count": 1,
    "uniques": 1
  }
]

Request

Response

Errors