API: Tags

The API enables the following interactions with tags:

• Get list of tags
• Add a tag
• Get tag details
• Update a tag
• Delete a tag

Note: Tags can also be created through the API when creating or updating results and programs, indicators and performance measures, or actions, via the "primaryTag" parameter.

Explanation of Tag Parameters

• description [string]* - Tag description (150 characters maximum)
• name [string]* - Tag name (15 characters maximum)

Get List of Tags

URL

https://api.resultsscorecard.com/api/tags/list

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO"
}

JSON Output

[
  {
    "ID": 2,
    "name": "Tag1",
    "description": "Desc of Tag1"
  },
  {
    "ID": 5,
    "name": "tag name",
    "description": "tag desc"
  },
  {
    "ID": 6,
    "name": "new tag",
    "description": "just another tag"
  }
]

Add a Tag

URL

https://api.resultsscorecard.com/api/tags/add

JSON Input

{
 siteCode: "abc",
 apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
 description: "tag Desc",
 name: "tag Name"
}

JSON Output

{
"ID":1026,
"name":"tag Name",
"description":"tag Desc"
}

Get Tag Details

URL

https://api.resultsscorecard.com/api/tags/details

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  id:2
}

JSON Output

{
  "ID":2,
  "name":"Tag1",
  "description":"Tag1"
}

Update a Tag

URL

https://api.resultsscorecard.com/api/tags/update

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  id:16,
  name: "updated tag",
  description: "updated tag description"
}

JSON Output

{
  "ID":16,
  "name":"updated tag",
  "description":"updated tag description"
}

Delete a Tag

URL

https://api.resultsscorecard.com/api/tags/delete

JSON Input

{
  siteCode: "abc",
  apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
  id:16
}

JSON Output

Successfully deleted tag [id].