Our API allows you to programmatically access all test results and settings from your account. This can be a pull for all projects, for a specific project, specific audit or test. In this article I show how you can try out the API calls with no coding required! All you need is your account’s API token. Then you can experiment with our end-point URLs at: api.verified-data.com.

All users, including non-paying, can access the API for free – limited to the first 4 sections of an audit.

If you have a 25 project or more license, the full API is now available at no extra cost.

Follow these 3 simple steps to get started:

  1. Generate your API token.
  2. Authorise your token.
  3. Explore the results.

1. Generate your API token

As a Verified Data admin, go to your account settings area and enable API access by generating your unique token. This is a one time process, though you can can generate a new token later if needed. Note, your token is generated at the account level. Therefore if your account has multiple administrators this may have already been created.

2. Authorise your token

Now go to api.verified-data.com and authorise the token you have just generated.

3. Explore the results – No coding required

Note, this is a read-only API – meaning you cannot alter any of the data. Hence it is completely safe for you to experiment with the API calls :).

Now that you are on the api.verified-data.com page, try out the GET requests to query your data directly. If you have worked with Google Analytics dataLayer, the JSON response will look pretty familiar. For my screenshot example below, I am using the first of the requests: /audits. That is, listing “for all projects the last five completed audits”.

The JSON response is grouped as follows:

    • Project Details – for example, each audit’s Quality Index score, when it ran, for which GA account/property/view.
    • Simulation Details – showing which region the simulation is made, browser, number of requested pages, list of start URLs and included/excluded pages.
    • Section Results – section name, its weighting, audit result and score.
    • Test Results – for each test, its name, id and real world description, result colour code.

Example Responses:

Project Details

"id": 1,
"project_id": "www-mysite-com",
"quality_index": 63.6,
"created_at": "2019-08-23T08:31:13+00:00",
"completed_at": "2019-08-23T13:28:11+00:00",
"is_partial": 0,
"google_analytics": {
   "account_id": "1234567",
   "property_id": "UA-1234567-1",
   "profile_id": "182849087"
},

Simulation Details

"settings": {
"simulation_date": "2019-08-23T09:15:04+00:00",
"region": "Europe / Ireland",
"browser": "Chrome",
"requested_urls": 1000,
"found_urls": 1000,
"start_urls": "https://www.mysite.com",
"allowed_domains": "swedol.se",
"urls_included": [],
"urls_excluded": [
   "c4_"
],
"ignore_query_parameters": [],
"noise_thresholds": {
   "general_tests": 10,
   "google_ads_tests": 50,
   "campaign_tracking_tests": 10
}
},

Section Results

"sections": [
{
"id": "adwords_data",
"weight": 1,
"result": "red",
"score": 0
},

Test Results

"tests": [
{
"id": "analytics_accounts_approved_domains",
"name": "Domains - All Approved",
"description": "Fail if domains with access to GA are not all formally approved in your Settings. Amber only",
"section_id": "google_analytics_account_setup",
"result": "amber"
},