arcade-mcp/toolkits/figma_api/arcade_figma_api/wrapper_tools/GetLibraryStyleUsageData.json

{
  "name": "GetLibraryStyleUsageData",
  "fully_qualified_name": "FigmaApi.GetLibraryStyleUsageData@0.1.0",
  "description": "Retrieve style usage data from Figma library analytics.\n\nThis tool returns library analytics style usage data from Figma, broken down by the requested dimension. It should be used to analyze style usage within a specific Figma library file.",
  "toolkit": {
    "name": "ArcadeFigmaApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "group_by_dimension",
        "required": true,
        "description": "Dimension to group the returned analytics data by. Options are 'style' or 'file'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "style",
            "file"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "A dimension to group returned analytics data by."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "group_by"
      },
      {
        "name": "library_file_key",
        "required": true,
        "description": "The file key of the Figma library to fetch analytics data for. This is required to specify the source library.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "File key of the library to fetch analytics data for."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "file_key"
      },
      {
        "name": "pagination_cursor",
        "required": false,
        "description": "Cursor indicating which page of data to fetch, obtained from a previous API call.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Cursor indicating what page of data to fetch. Obtained from prior API call."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "cursor"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getLibraryAnalyticsStyleUsages'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-figma",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": {
        "scopes": [
          "library_analytics:read"
        ]
      }
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.0.0",
    "description": "Tools that enable LLMs to interact directly with the figma API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.1.0",
      "description": ""
    },
    "url": "https://api.figma.com/v1/analytics/libraries/{file_key}/style/usages",
    "http_method": "GET",
    "headers": {
      "Content-Type": "application/json"
    },
    "parameters": [
      {
        "name": "cursor",
        "tool_parameter_name": "pagination_cursor",
        "description": "Cursor indicating what page of data to fetch. Obtained from prior API call.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Cursor indicating what page of data to fetch. Obtained from prior API call."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "group_by",
        "tool_parameter_name": "group_by_dimension",
        "description": "A dimension to group returned analytics data by.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "style",
            "file"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "A dimension to group returned analytics data by."
        },
        "accepted_as": "query",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "file_key",
        "tool_parameter_name": "library_file_key",
        "description": "File key of the library to fetch analytics data for.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "File key of the library to fetch analytics data for."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": null,
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}