Get search analytics

Get search analytics including top queries, search volume, and performance metrics. Accepts BearerToken (JWT) or ApiKeyAuth (X-API-Key).

GET/api/search/projects/{projectId}/search/analytics

Authentication

Requires JWT

Note

Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID (MongoDB ObjectId) to get analytics for.

Query Parameters

Name	Type	Required	Description
`timeframe`	string	No	Timeframe for analytics (1d, 7d, or 30d).

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.search.getAnalytics({
  projectId: "proj_0ah2Jsp5HLOt"
});
const result = await client.search.getAnalytics({
  projectId: "proj_0ah2Jsp5HLOt"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

Query Parameters

timeframe

No Request Yet

Send a request to see the full inspector

Responses

200Search analytics

json

{
  "totalSearches": 1250,
  "topQueries": [
    {
      "query": "john",
      "count": 45
    },
    {
      "query": "user",
      "count": 32
    }
  ],
  "searchesByCollection": {
    "users": 800,
    "products": 450
  },
  "averageResponseTime": 45.2
}
{
  "totalSearches": 1250,
  "topQueries": [
    {
      "query": "john",
      "count": 45
    },
    {
      "query": "user",
      "count": 32
    }
  ],
  "searchesByCollection": {
    "users": 800,
    "products": 450
  },
  "averageResponseTime": 45.2
}

401Authentication required or invalid token.

403Access denied or insufficient permissions.

Errors

Code	Meaning
`401`	Authentication required or invalid token.
`403`	Access denied or insufficient permissions.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub