{"openapi":"3.1.0","info":{"title":"Figma Library Analytics (BYOK) API","version":"0.1.0","description":"Figma Library Analytics (BYOK) lets an AI assistant read your own Figma Library Analytics data through the Figma Library Analytics API with a key you supply (personal access token (library_analytics:read scope)). Read-only: 6 tools (get_component_actions, get_component_usages, get_style_actions, get_style_usages, get_variable_actions, get_variable_usages). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-figma-library-analytics.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-figma-library-analytics/docs"},"termsOfService":"https://connectorbay.com/byok-figma-library-analytics/terms"},"servers":[{"url":"https://byok-figma-library-analytics.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-figma-library-analytics/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_component_actions":{"post":{"operationId":"get_component_actions","summary":"Weekly insertions and detachments of a library's components, grouped by component or by team. Enterprise full members on","description":"Weekly insertions and detachments of a library's components, grouped by component or by team. Enterprise full members only. Use for \"How often were the components of Figma library abc123XYZ inserted or detached\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"Key of the library file to report on (the part after /file/ or /design/ in the Figma URL).","maxLength":200,"title":"File Key","type":"string"},"group_by":{"description":"Group rows by 'component' or 'team'.","enum":["component","team"],"title":"Group By","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the range as YYYY-MM-DD (rounded to the start of a week).","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the range as YYYY-MM-DD (rounded to the end of a week).","title":"End Date"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the 'cursor' value of the previous answer to get the next page (omit for the first page).","title":"Cursor"}},"required":["file_key","group_by"],"title":"get_component_actionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_component_usages":{"post":{"operationId":"get_component_usages","summary":"Current usage counts of a library's components, grouped by component or by consuming file. Enterprise full members only.","description":"Current usage counts of a library's components, grouped by component or by consuming file. Enterprise full members only. Use for \"Which components of Figma library abc123XYZ are used the most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"Key of the library file to report on (the part after /file/ or /design/ in the Figma URL).","maxLength":200,"title":"File Key","type":"string"},"group_by":{"description":"Group rows by 'component' or 'file'.","enum":["component","file"],"title":"Group By","type":"string"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the 'cursor' value of the previous answer to get the next page (omit for the first page).","title":"Cursor"}},"required":["file_key","group_by"],"title":"get_component_usagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_style_actions":{"post":{"operationId":"get_style_actions","summary":"Weekly insertions and detachments of a library's styles, grouped by style or by team. Enterprise full members only. Use ","description":"Weekly insertions and detachments of a library's styles, grouped by style or by team. Enterprise full members only. Use for \"How often were the styles of Figma library abc123XYZ applied or detached\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"Key of the library file to report on (the part after /file/ or /design/ in the Figma URL).","maxLength":200,"title":"File Key","type":"string"},"group_by":{"description":"Group rows by 'style' or 'team'.","enum":["style","team"],"title":"Group By","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the range as YYYY-MM-DD (rounded to the start of a week).","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the range as YYYY-MM-DD (rounded to the end of a week).","title":"End Date"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the 'cursor' value of the previous answer to get the next page (omit for the first page).","title":"Cursor"}},"required":["file_key","group_by"],"title":"get_style_actionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_style_usages":{"post":{"operationId":"get_style_usages","summary":"Current usage counts of a library's styles, grouped by style or by consuming file. Enterprise full members only. Use for","description":"Current usage counts of a library's styles, grouped by style or by consuming file. Enterprise full members only. Use for \"Which styles of Figma library abc123XYZ are used the most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"Key of the library file to report on (the part after /file/ or /design/ in the Figma URL).","maxLength":200,"title":"File Key","type":"string"},"group_by":{"description":"Group rows by 'style' or 'file'.","enum":["style","file"],"title":"Group By","type":"string"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the 'cursor' value of the previous answer to get the next page (omit for the first page).","title":"Cursor"}},"required":["file_key","group_by"],"title":"get_style_usagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_variable_actions":{"post":{"operationId":"get_variable_actions","summary":"Weekly insertions and detachments of a library's variables, grouped by variable or by team. Enterprise full members only","description":"Weekly insertions and detachments of a library's variables, grouped by variable or by team. Enterprise full members only. Use for \"How often were the variables of Figma library abc123XYZ used or detached\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"Key of the library file to report on (the part after /file/ or /design/ in the Figma URL).","maxLength":200,"title":"File Key","type":"string"},"group_by":{"description":"Group rows by 'variable' or 'team'.","enum":["variable","team"],"title":"Group By","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"First day of the range as YYYY-MM-DD (rounded to the start of a week).","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Last day of the range as YYYY-MM-DD (rounded to the end of a week).","title":"End Date"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the 'cursor' value of the previous answer to get the next page (omit for the first page).","title":"Cursor"}},"required":["file_key","group_by"],"title":"get_variable_actionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_variable_usages":{"post":{"operationId":"get_variable_usages","summary":"Current usage counts of a library's variables, grouped by variable or by consuming file. Enterprise full members only. U","description":"Current usage counts of a library's variables, grouped by variable or by consuming file. Enterprise full members only. Use for \"Which variables of Figma library abc123XYZ are used the most\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file_key":{"description":"Key of the library file to report on (the part after /file/ or /design/ in the Figma URL).","maxLength":200,"title":"File Key","type":"string"},"group_by":{"description":"Group rows by 'variable' or 'file'.","enum":["variable","file"],"title":"Group By","type":"string"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the 'cursor' value of the previous answer to get the next page (omit for the first page).","title":"Cursor"}},"required":["file_key","group_by"],"title":"get_variable_usagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}