Get link performance score (0-100)

GET

/api/v1/links/{code}/analytics/performance-score

const url = 'https://example.com/api/v1/links/example/analytics/performance-score';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/links/example/analytics/performance-score \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

code

required

string

Short code or custom alias

Responses

200

application/json

object

shortCode

required

string

overallScore

required

number

label

required

string

subScores

required

Array<object>

object

name

required

string

label

required

string

score

required

number

maxScore

required

number

detail

required

string

mode

required

string

Allowed values: diverse concentrated

calculatedAt

required

string

Example

{
  "overallScore": 72,
  "label": "Good",
  "subScores": [
    {
      "name": "clickVelocity",
      "label": "Click Velocity",
      "score": 18.5,
      "maxScore": 25,
      "detail": "12.3 clicks/day"
    }
  ],
  "mode": "diverse"
}

403

Forbidden — not the owner

404

Link not found