ONIK API (v0)

Obtain an API key by contacting ONIK support. The x-api-key HTTP header is required for all requests.

Example: Authenticated Curl request

curl -X GET "https://api.onik.io/v0/sites" -H "x-api-key: YOUR_API_KEY"

Example: How has a site name ONIK been performing recently?

curl -X GET "https://api.onik.io/v0/scores/summary?siteName=Onik" -H "x-api-key: YOUR_API_KEY"

Results

    {
      "key": "Onik",
      "doc_count": 81,
      "min": 93,
      "avg": 93.7,
      "max": 95,
      "accessibility_max": 100,
      "accessibility_min": 92,
      "accessibility_avg": 95.5,
      "latest": [
        {
          ... The most recent Site Score Calculation
        }
      ]
      ...
    }

The fields avg, min, and max are the average, minimum, and maximum scores for the site over the period of time. Similarly, the accessibility_avg, accessibility_min, and accessibility_max fields represent the average, minimum, and maximum accessibility scores over the same period.

Example: How are all of my sites performing recently?

Similar to the previous example, but without the siteName parameter. This will return an array of summary scores for all sites in your account.

curl -X GET "https://api.onik.io/v0/scores/summary" -H "x-api-key: YOUR_API_KEY"

Sites are the primary way ONIK organizes website performance monitors. Sites have a name, url, and a series of settings which control how the site is monitored and audited. This section allows you to see all the sites in your account.

Scores represent a Site's Overall Health rated out of 100, and is the same scores shown in the ONIK App Interface and Site Scorecard. This score takes into account all of the performance metrics across aSite's monitored pages. Site Score's are recalculated every 2 hours, and cover a period of the previous 7 days.

The Weighted Score combines the following metrics: - Uptime / Downtime - Response Time - Performance Score and Core Web Vitals (LCP, FCP, TBT, CLS)

Response times are in microseconds.

Divide by 1,000,000 to convert to seconds. Example: 195183 microseconds is 0.195183 seconds.