API metrics

⚠️ All the API for metrics are in a beta version, and can change at any moment. We give early access to the metrics for your benefit.

Version 0.0
Endpoint /-api/metrics/v0

Project Stats

Annotation Stats

Stats for the (master) annotations, such as the count for a document label’s specific value, number of anncomplete (confirmed) documents, top normalizations for an entity type, etc.

Endpoint /-api/metrics/v0/search_stats?owner=...&project=...
Method GET
Output JSON

Input Parameters

Defined as URL query parameters.

Name Default Example Description
search - * Document search, allowing any usual search parameter. Common is to just search for * to get all the project's (documents) statistics.

Coding examples

curl -u 'yourUsername:yourPassword' 'https://www.tagtog.net/-api/metrics/v0/search_stats?project=yourProjectName&owner=yourUsername&search=*'

IAA

Get individual IAA for a pair of members

Endpoint /-api/metrics/v0/iaa?owner=...&project=...
Method GET
Output JSON

Input Parameters

Defined as URL query parameters.

Name Default Example Description
member1 - yourUsername Username of the first member of the members pair to get the IAA for.
member2 - Laura Username of the second member of the members pair to get the IAA for.
anntaskId - e_21 The id (anntaskId) of one of your annotation types in the project
metric - exact_v1 The name of the metric you want, typically exact_v1 (this is the same metric used in the default IAA visualizations). Possible values: {exact_v1, overlapping_v1, documentlevel_v1}

Coding examples

curl -u 'yourUsername:yourPassword' 'https://www.tagtog.net/-api/metrics/v0/iaa?project=yourProjectName&owner=yourUsername&member1=yourUsername&member2=Laura&anntaskId=e_21&metric=exact_v1'