Detected country: US
logo
Open AppStatusSubmit Ticket
GuideAPI References
‌
‌
‌
logo

Powered by

  • Home
  • Advanced
  • API Reference
  • Get company search queries

Get company search queries

4min read

Share

Returns a paginated list of company search queries for a given team, with optional filters and metadata. Requires authentication.

Endpoint

https://app.brainfi.sh/api/searches.public.company

Authentication

Bearer token: Use the API tokens you created at https://app.brainfi.sh/settings/token

Example Curl

curl -X POST https://app.brainfi.sh/api/searches.public.company \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRange": {
      "from": 1738368000000,
      "to": 1740787199999
    },
    "limit": 10,
    "offset": 0,
    "filters": {},
    "sources": []
  }'

Request body schema

requestBody:
  required: true
  content:
    application/json:
      schema:
        type: object
        properties:
          dateRange:
            type: object
            required:
              - from
              - to
            properties:
              from:
                type: number
                format: unix timestamp in milliseconds
                example: 1738368000000
              to:
                type: number
                format: unix timestamp in milliseconds
                example: 1738368000000
          sources:
            type: array
            items:
              type: string
            description: Optional. Filter by search source (e.g., "widget", "api").
            example: ["slack", "app", "api", "help_center", "widget", "agent_assist"]
          filters:
            searchQuery:
              type: string
              description: Optional. Search query to filter by
              example: "What is Brainfish?"
            answerStatus: 
              type: array
              items:
                type: string
              description: Optional. Answer status to filter by
              example: ["answered", "unanswered"]
            agentIds: 
              type: array
              items: 
                type: string
              description: Optional. Filter by AgentIds
              example: ["bf_search_widget_xxxxxx"]
          limit:
            type: integer
            description: Optional. Number of results per page. Default 10.
            example: 10
          offset:
            type: integer
            description: Optional. Pagination offset. Default 0.
            example: 0
        required:
          - dateRange
          - teamId

Share