1. Analysis
Edit this page

Get URL Information

Botify API allows you to get information on any URL analyzed by Botify Analytics. Full list of requestable fields can be found in Analysis Datamodel.

Endpoint

  • Operation: getUrlDetail
  • Path: analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}
  • HTTP Verb: GET
  • Response: Object
curl "https://api.botify.com/v1/analyses/${username}/${project_slug}/${analysis_slug}/urls/${url}?fields=${fields}" \
     -X GET \
     -H "Authorization: Token ${API_KEY}" \
     -H "Content-type: application/json"

Example

The following returns the fields http_code, delay_last_byte and outlinks_internal of the URL http://www.nytimes.com/ (note that the URL needs to be encoded).

https://api.botify.com/v1/analyses/adam_warlock/demo-project/20150929/urls/http%3A%2F%2Fwww.nytimes.com%2F?fields=http_code,delay_last_byte,outlinks_internal

Requested fields and their children are returned. If you only need to get the number of unique internal outlinks, you should specifically request outlinks_internal.nb.unique instead outlinks_internal, as it will be faster.

A sample result would be the following. 

{
  "delay_last_byte": 254,
  "http_code": 200,
  "outlinks_internal": {
    "nb": {
      "follow": {
        "unique": 29,
        "total": 31
      },
      "unique": 29,
      "total": 31,
      "nofollow": {
        "combinations": {
          "link_meta_robots": 0,
          "robots": 0,
          "meta": 0,
          "link": 0,
          "link_meta": 0,
          "meta_robots": 0,
          "link_robots": 0
        },
        "unique": 0,
        "total": 0
      }
    }
  }
}