249 lines
8.6 KiB
JSON
249 lines
8.6 KiB
JSON
{
|
|
"name": "GetLibraryAnalyticsComponentActions",
|
|
"fully_qualified_name": "FigmaApi.GetLibraryAnalyticsComponentActions@0.1.0",
|
|
"description": "Get analytics for library component actions.\n\nRetrieve detailed data on library component actions in Figma, broken down by the specified dimension. This tool is used to gain insights into how components in a Figma library are being utilized.",
|
|
"toolkit": {
|
|
"name": "ArcadeFigmaApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "group_by_dimension",
|
|
"required": true,
|
|
"description": "Specify the dimension to group the analytics data by. Options are 'component' or 'team'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"component",
|
|
"team"
|
|
],
|
|
"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 unique file key for the Figma library to retrieve analytics data from.",
|
|
"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": "data_page_cursor",
|
|
"required": false,
|
|
"description": "Cursor indicating the specific 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"
|
|
},
|
|
{
|
|
"name": "earliest_start_date",
|
|
"required": false,
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) for the earliest week to include. Rounded back to the start of a week. Defaults to one year prior.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the earliest week to include. Dates are rounded back to the nearest start of a week. Defaults to one year prior."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "start_date"
|
|
},
|
|
{
|
|
"name": "latest_inclusion_date",
|
|
"required": false,
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the latest week to include, rounded forward to the nearest week's end. Defaults to the latest computed week.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the latest week to include. Dates are rounded forward to the nearest end of a week. Defaults to the latest computed week."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "end_date"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'getLibraryAnalyticsComponentActions'.",
|
|
"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}/component/actions",
|
|
"http_method": "GET",
|
|
"headers": {
|
|
"Content-Type": "application/json"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "cursor",
|
|
"tool_parameter_name": "data_page_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": [
|
|
"component",
|
|
"team"
|
|
],
|
|
"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": "start_date",
|
|
"tool_parameter_name": "earliest_start_date",
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the earliest week to include. Dates are rounded back to the nearest start of a week. Defaults to one year prior.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the earliest week to include. Dates are rounded back to the nearest start of a week. Defaults to one year prior."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"tool_parameter_name": "latest_inclusion_date",
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the latest week to include. Dates are rounded forward to the nearest end of a week. Defaults to the latest computed week.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "ISO 8601 date string (YYYY-MM-DD) of the latest week to include. Dates are rounded forward to the nearest end of a week. Defaults to the latest computed week."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"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
|
|
}
|
|
}
|