list_keyword_searches
Retrieve paginated keyword search results from social media platforms, filtered by completion status to monitor search progress and outcomes.
Instructions
List all keyword searches. Returns a paginated list filtered by status.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| show | No | Filter by status (default: all) | |
| page | No | Page number (100 results per page) |
Implementation Reference
- src/tools/keyword-search.ts:23-34 (handler)The handler function that executes the API call for listing keyword searches.
async (params) => { try { const queryParts: string[] = []; if (params.show) queryParts.push(`show=${params.show}`); if (params.page !== undefined) queryParts.push(`page=${params.page}`); const query = queryParts.length ? `?${queryParts.join("&")}` : ""; const data = await apiGet(`/iq/keyword_search${query}`); return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] }; } catch (e) { return { content: [{ type: "text", text: String(e) }], isError: true }; } } - src/tools/keyword-search.ts:16-22 (registration)Schema definition for the inputs to the list_keyword_searches tool.
{ show: z .enum(["all", "started", "finished", "pending", "failed"]) .optional() .describe("Filter by status (default: all)"), page: z.number().int().positive().optional().describe("Page number (100 results per page)"), },