fyi.opensocial.getTemplateUse

lexicons.opensocial.fyi

Documentation

How groups on this host use a template shared with everyone, for whoever made it: counts, never which groups, and never what anyone wrote in a tab of it, which stays in each group. Groups on other hosts can't be seen. For a person's template, them; for a group's, whoever may publish for it.

main query

How groups on this host use a template shared with everyone, for whoever made it: counts, never which groups, and never what anyone wrote in a tab of it, which stays in each group. Groups on other hosts can't be seen. For a person's template, them; for a group's, whoever may publish for it.

Parameters

uri string at-uri Required

The template, its fyi.opensocial.template.

Output

Encodingapplication/json
bar ref#barView Required

What it takes to be listed here.

keptAWhile integer Required

Of those, the groups that have had it for as long as the bar asks.

keptBy integer Required

Groups with a tab of it now, of any version.

notNow array Required

Versions groups undid, and how many groups for each.

tookOff integer Required

Groups that removed a tab of it in the last 30 days and have none now.

Errors

NotFound
Forbidden
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
The template, its fyi.opensocial.template.
View raw schema 
{
  "description": "How groups on this host use a template shared with everyone, for whoever made it: counts, never which groups, and never what anyone wrote in a tab of it, which stays in each group. Groups on other hosts can't be seen. For a person's template, them; for a group's, whoever may publish for it.",
  "errors": [
    {
      "name": "NotFound"
    },
    {
      "name": "Forbidden"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "bar": {
          "description": "What it takes to be listed here.",
          "ref": "#barView",
          "type": "ref"
        },
        "keptAWhile": {
          "description": "Of those, the groups that have had it for as long as the bar asks.",
          "minimum": 0,
          "type": "integer"
        },
        "keptBy": {
          "description": "Groups with a tab of it now, of any version.",
          "minimum": 0,
          "type": "integer"
        },
        "notNow": {
          "description": "Versions groups undid, and how many groups for each.",
          "items": {
            "ref": "#notNowView",
            "type": "ref"
          },
          "type": "array"
        },
        "tookOff": {
          "description": "Groups that removed a tab of it in the last 30 days and have none now.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "keptBy",
        "keptAWhile",
        "tookOff",
        "notNow",
        "bar"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "uri": {
        "description": "The template, its fyi.opensocial.template.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "uri"
    ],
    "type": "params"
  },
  "type": "query"
}
barView object

No description available.

Properties

days integer Required

For how many days.

minimum: 0
groups integer Required

How many groups keep it.

minimum: 1
View raw schema 
{
  "properties": {
    "days": {
      "description": "For how many days.",
      "minimum": 0,
      "type": "integer"
    },
    "groups": {
      "description": "How many groups keep it.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "groups",
    "days"
  ],
  "type": "object"
}
notNowView object

No description available.

Properties

groups integer Required

No description available.

minimum: 1
number integer Optional

No description available.

minimum: 1
version string cid Required

A content identifier (CID) referencing immutable data.

View raw schema 
{
  "properties": {
    "groups": {
      "minimum": 1,
      "type": "integer"
    },
    "number": {
      "minimum": 1,
      "type": "integer"
    },
    "version": {
      "format": "cid",
      "type": "string"
    }
  },
  "required": [
    "version",
    "groups"
  ],
  "type": "object"
}

Lexicon Garden

@