Tag Documentation


Tags on Item Documents

Every Item document is assigned tags to give API consumers more details about the type of crisis information it covers. A tag has name and confidence properties. For example:

item = {
    content: 'Example content',
    geo: {
        formattedAddress: '123 Main St, Anytown, USA',
        coords: [30.12345, -97.5678]
    },
    tags: [
        {
            name: 'tag-one',
            confidence: 1
        },
        {
            name: 'tag-two',
            confidence: .5
        }
    ]
    ...
}
  

The confidence property indicates the likelihood that the tag has been accurately assigned.

Many data sources have their own methods for categorizing content. CrisisNET respects tag names applied by other systems, and also attempts to assign at least one (often many) "system tag(s)", so that, as often as possible, API consumers can rely on consistent categorization of content throughout the CrisisNET platform. System tags can be found at the /system-tag API endpoint.

import requests

r = requests.get('http://api.crisis.net/system-tag')
  

The System Tag Endpoint

Here's an example document returned from the /system-tag endpoint. This endpoint can be filtered by categories, as described below.

{
  _id: "536d54cb017e3d0000c62d36",
  categories: [
    "conflict"
  ],
  createdAt: "2014-05-09T22:20:59.579Z",
  name: "air-combat",
  updatedAt: "2014-05-09T22:20:59.580Z"
}
  

As you can see, each tag is assigned to some categories. These categories can be used as a filter when retrieving tag documents from the /system-tag endpoint. For example:

import requests

r = requests.get('http://api.crisis.net/system-tag?categories=conflict&apikey=YOUR-API-KEY')
print r.json()
  

The available categories are: