pub.chive.tag.getDetail

chive.pub

Documentation

Get detailed information for a specific tag

main query

Get detailed information for a specific tag

Parameters

tag string Required

Normalized tag form to look up

Output

Encodingapplication/json
Schema#tagSummary

Errors

TagNotFound
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Normalized tag form to look up
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "TagNotFound"
    }
  ],
  "output": {
    "schema": {
      "ref": "#tagSummary",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "tag"
    ],
    "properties": {
      "tag": {
        "type": "string",
        "description": "Normalized tag form to look up"
      }
    }
  },
  "description": "Get detailed information for a specific tag"
}
promotionTarget object

Target of tag promotion

Properties

type string Required

Type of promotion target

Known values: facet, authority
uri string Required

URI of the promotion target

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "description": "URI of the promotion target"
    },
    "type": {
      "type": "string",
      "description": "Type of promotion target",
      "knownValues": [
        "facet",
        "authority"
      ]
    }
  },
  "description": "Target of tag promotion"
}
tagSummary object

Summary information for a tag

Properties

displayForms array of string Required

All display forms used for this tag

isPromoted boolean Required

Whether the tag has been promoted to a facet or authority

normalizedForm string Required

Normalized tag form (lowercase, hyphenated)

qualityScore integer Required

Tag quality score (0-100, scaled from 0-1)

minimum: 0maximum: 100
usageCount integer Required

Number of eprints tagged with this tag

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "normalizedForm",
    "displayForms",
    "usageCount",
    "qualityScore",
    "isPromoted"
  ],
  "properties": {
    "isPromoted": {
      "type": "boolean",
      "description": "Whether the tag has been promoted to a facet or authority"
    },
    "promotedTo": {
      "ref": "#promotionTarget",
      "type": "ref",
      "description": "Promotion target if promoted"
    },
    "usageCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of eprints tagged with this tag"
    },
    "displayForms": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "All display forms used for this tag"
    },
    "qualityScore": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Tag quality score (0-100, scaled from 0-1)"
    },
    "normalizedForm": {
      "type": "string",
      "description": "Normalized tag form (lowercase, hyphenated)"
    }
  },
  "description": "Summary information for a tag"
}

Lexicon Garden

@