--- updatedAt: 2025-09-05T05:35:53.000Z agentTools: projectIndex: https://workduo.readme.io/llms.txt --- # Get Responses Retrieves raw AI-generated response data with associated metrics (Visibility, Share of Voice, Position) and citations for a specified Project. Supports filtering by platform (e.g., ChatGPT, DeepSeek), date range up to 1 month, optional region, query ID, and topic ID filtering, pagination, and sorting by multiple fields. If both query_id and topic_id are provided, query_id takes precedence. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Workduo Core API", "version": "1.0.6", "description": "API for managing and retrieve core objects in Workduo such as query, responses and citaiton." }, "servers": [ { "url": "https://api.workduo.ai/core/v1" } ], "paths": { "/responses": { "get": { "operationId": "getResponses", "summary": "Get Responses", "description": "Retrieves raw AI-generated response data with associated metrics (Visibility, Share of Voice, Position) and citations for a specified Project. Supports filtering by platform (e.g., ChatGPT, DeepSeek), date range up to 1 month, optional region, query ID, and topic ID filtering, pagination, and sorting by multiple fields. If both query_id and topic_id are provided, query_id takes precedence.", "parameters": [ { "name": "projectId", "in": "query", "description": "The ID of the Project to retrieve responses for (e.g., project tracking Acme Limited).", "required": true, "schema": { "type": "string", "example": "cjld2cjxh0000qzrmn831i7rn" } }, { "name": "dateRange", "in": "query", "description": "The date range for the data. Use 'custom' for specific dates.", "required": true, "schema": { "type": "string", "enum": [ "today", "yesterday", "last7days", "lastweek", "last30days", "lastmonth", "custom" ], "example": "last30days" } }, { "name": "startDate", "in": "query", "description": "Start date for custom date range (YYYY-MM-DD). Required if dateRange is 'custom'.", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-08-10" } }, { "name": "endDate", "in": "query", "description": "End date for custom date range (YYYY-MM-DD). Required if dateRange is 'custom'.", "required": false, "schema": { "type": "string", "format": "date", "example": "2025-08-12" } }, { "name": "region", "in": "query", "description": "The region code to filter data (e.g., 'US' for United States). If not provided, returns data for all regions.", "required": false, "schema": { "type": "string", "example": "US" } }, { "name": "platform", "in": "query", "description": "The platform to filter data (e.g., 'openai:chatgpt' for ChatGPT). If not provided, returns data for all platforms. Supports multiple values with comma-separated values e.g. \"openai:chatgpt,google:ai-overview\".", "required": false, "schema": { "type": "string", "example": "openai:chatgpt" } }, { "name": "queryId", "in": "query", "description": "The ID of the query to filter responses. If provided, takes precedence over topicId. If not provided, returns responses for all queries.", "required": false, "schema": { "type": "string", "example": "cmcd9jhnt00442k13g5duy86y" } }, { "name": "pageSize", "in": "query", "description": "The number of records to return per page. Defaults to 10.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10, "example": 10 } }, { "name": "pageToken", "in": "query", "description": "A token identifying the starting point for the next page of results. Use an empty string for the first page.", "required": false, "schema": { "type": "string", "default": "", "example": "next_page_token_abc123" } }, { "in": "query", "name": "queryMetadata", "schema": { "type": "string" }, "description": "Fields to filter query, as a JSON object (e.g., '{\"key-1\": [\"val-1-1\", \"val-1-2\"], \"key-2\": [\"val-2-1\"]}')" } ], "responses": { "200": { "description": "Successful response with raw AI-generated response data", "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "description": "The ID of the Project (e.g., cjld2cjxh0000qzrmn831i7rn for Acme Limited).", "example": "cjld2cjxh0000qzrmn831i7rn" }, "data": { "type": "array", "description": "Array of raw AI response data with metrics and citations.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the response.", "example": "rst012uvw345xyz678abc901" }, "platform": { "type": "string", "description": "The platform that generated the response (e.g., 'openai:chatgpt' for ChatGPT).", "example": "openai:chatgpt" }, "selfMentioned": { "type": "boolean", "description": "Indicates whether the tracked entity is mentioned in the response.", "example": true }, "sov": { "type": "number", "description": "Share of Voice metric value for the response (decimal, e.g., 1 for 100%).", "example": 0.33 }, "position": { "type": "number", "description": "Position metric value for the response (integer, e.g., 1 for first mention).", "example": 2 }, "mentionedEntities": { "type": "array", "description": "Array of entities mentioned in the response.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the entity.", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "name": { "type": "string", "description": "Name of the entity.", "example": "Acme Limited" }, "type": { "type": "string", "description": "Type of entity (e.g., PRIMARY for the tracked entity).", "example": "PRIMARY" } } } }, "content": { "type": "string", "description": "The full text of the AI-generated response.", "example": "Here’s an overview of top consulting firms near you, assuming you’re located in New York, NY..." }, "citations": { "type": "array", "description": "Array of citations included in the response.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the citation.", "example": "https://www.peaksolutions.com/about?utm_source=openai" }, "type": { "type": "string", "description": "Type of citation (e.g., OTHERS, OWNED).", "example": "OTHERS" }, "title": { "type": "string", "description": "Title of the citation.", "example": "About Us | Peak Solutions" } } } }, "region": { "type": "string", "description": "The region associated with the response (e.g., 'US' for United States).", "example": "US" }, "date": { "type": "array", "items": { "type": "string", "format": "date" } } }, "required": [ "date", "id" ] } }, "nextPageToken": { "type": "string", "nullable": true, "description": "Token for the next page of results. Null if no more pages are available.", "example": "next_page_token_def456" } } }, "example": { "projectId": "cjld2cjxh0000qzrmn831i7rn", "data": [ { "id": "rst012uvw345xyz678abc901", "platform": "openai:chatgpt", "selfMentioned": true, "sov": 0.33, "visibility": 0.8, "position": 2, "topicId": "top123ghi456", "topic": "Consulting Firms", "queryId": "qry789jkl012mno345pqr678", "query": "top consulting firms near me", "mentionedEntities": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Acme Limited", "type": "PRIMARY" }, { "id": "c3d4e5f6-g7h8-9012-cdef-gh2345678901", "name": "Peak Solutions", "type": "COMPETITOR" }, { "id": "e5f6g7h8-i9j0-1234-efgh-ij3456789012", "name": "Bright Consulting Group", "type": "COMPETITOR" } ], "content": "Here’s an overview of top consulting firms near you, assuming you’re located in New York, NY, based on publicly available information:\n\n**1. Peak Solutions**\n- **Overview**: Peak Solutions is a well-established firm offering strategy, operations, and technology consulting, with a strong presence in New York. They are known for data-driven approaches and a client-centric model. [1]\n- **Strengths**: Their website highlights a broad client portfolio and expertise in financial services. Reviews on platforms like Clutch note reliable delivery but mention occasional delays in complex projects. [2]\n\n**2. Acme Limited**\n- **Overview**: Acme Limited provides consulting services in business strategy, digital transformation, and process optimization, with an office in New York. They cater to mid-sized businesses and emphasize measurable outcomes. [3]\n- **Strengths**: Acme Limited is recognized for structured methodologies and consistent communication, as per client testimonials. However, some reviews suggest their solutions can feel standardized, which may not suit highly specialized needs. [4]\n\n**3. Bright Consulting Group**\n- **Overview**: A boutique firm in New York, Bright Consulting Group focuses on innovation and sustainability consulting, often working with startups and tech firms. [5]\n- **Strengths**: They are praised for creative problem-solving, though their smaller size may limit scalability for large enterprises, according to online feedback. [6]\n\n**Comparison**\n- All three firms are reputable, with Acme Limited and Peak Solutions offering broader services compared to Bright Consulting Group’s niche focus. Pricing varies, with Acme and Peak often charging premium rates, while Bright is more competitive for smaller projects. [7]\n\n**Recommendation**\nThese firms are strong options depending on your needs. Acme Limited is a solid choice for structured, results-driven consulting, while Peak Solutions excels in finance, and Bright Consulting Group suits innovative projects. If you share your specific industry or location, I can refine this list further.\n\n**Sources**:\n[1] https://www.peaksolutions.com/about\n[2] https://www.clutch.co/profile/peak-solutions\n[3] https://www.acmelimited.com/services\n[4] https://www.glassdoor.com/Reviews/Acme-Limited-Consulting-Reviews-EI_IE987654.0,12.htm?utm_source=openai\n[5] https://www.brightconsultinggroup.com/our-services\n[6] https://www.clutch.co/profile/bright-consulting-group\n[7] https://www.consultinginsights.com/top-firms-nyc-2025", "citations": [ { "url": "https://www.peaksolutions.com/about?utm_source=openai", "type": "OTHERS", "title": "About Us | Peak Solutions" }, { "url": "https://www.clutch.co/profile/peak-solutions?utm_source=openai", "type": "OTHERS", "title": "Peak Solutions Reviews | Clutch" }, { "url": "https://www.acmelimited.com/services?utm_source=openai", "type": "OWNED", "title": "Our Services | Acme Limited" }, { "url": "https://www.glassdoor.com/Reviews/Acme-Limited-Consulting-Reviews-EI_IE987654.0,12.htm?utm_source=openai", "type": "OTHERS", "title": "Acme Limited Consulting Reviews | Glassdoor" }, { "url": "https://www.brightconsultinggroup.com/our-services?utm_source=openai", "type": "OTHERS", "title": "Our Services | Bright Consulting Group" }, { "url": "https://www.clutch.co/profile/bright-consulting-group?utm_source=openai", "type": "OTHERS", "title": "Bright Consulting Group Reviews | Clutch" }, { "url": "https://www.consultinginsights.com/top-firms-nyc-2025?utm_source=openai", "type": "OTHERS", "title": "Top Consulting Firms in NYC 2025 | Consulting Insights" } ], "region": "US" } ], "nextPageToken": "next_page_token_def456" } } } }, "400": { "description": "Bad request (e.g., invalid projectId, region, platform, query_id, topic_id, pageSize, pageToken, orderBy, or missing required parameters)", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Invalid projectId, region, platform, query_id, topic_id, pageSize, pageToken, orderBy, or missing required parameters" } } } } } }, "401": { "description": "Unauthorized (e.g., invalid API key)", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Unauthorized access" } } } } } }, "404": { "description": "Project, query, or topic not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Project with ID cjld2cjxh0000qzrmn831i7rn not found" } } } } } } }, "security": [ { "BasicAuth": [] } ], "tags": [ "Responses" ] } } }, "components": { "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "basic" } } } } ```