# Get Client Analytics

## Get client analysis

> Retrieve client analysis data including followers, blocks, message numbers, and tag coverage rates.\
> \
> Platform filtering:\
> \- If platform is not specified, returns data for all platforms\
> \- If platform is specified, returns data only for that platform\
> \
> Supported platforms: line, facebook, instagram, liveChat, whatsapp

```json
{"openapi":"3.0.3","info":{"title":"Manta OpenAPI","version":"0.318.0"},"tags":[{"name":"Core","description":"Core OpenAPI functionality for customer management and broadcasting"}],"servers":[{"url":"https://mantago.cc/api","description":"MantaGo Openapi host url"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token for API authentication"}},"schemas":{"ClientAnalysisRequest":{"type":"object","properties":{"secret":{"type":"string","description":"Secret key for API authentication"},"platform":{"type":"string","enum":["line","facebook","instagram","liveChat","whatsapp"],"description":"Platform type for filtering (optional, if not provided returns all platforms)"}},"required":["secret"]},"ClientAnalysisResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"clientAnalysis":{"type":"object","description":"Client analysis data. Fields returned depend on the platform parameter:\n- If platform is not specified or 'all': Returns data for all platforms plus totals\n- If platform is specified: Returns data only for that platform","properties":{"lineFollowers":{"type":"integer","description":"Number of LINE followers (returned when platform is 'line' or not specified)"},"lineBlocks":{"type":"integer","description":"Number of LINE blocks (returned when platform is 'line' or not specified)"},"lineGenders":{"type":"array","description":"LINE gender demographics data (returned when platform is 'line' or not specified)","items":{"type":"object","properties":{"name":{"type":"string","description":"Gender name in Chinese"},"percentage":{"type":"number","format":"float","description":"Percentage of users in this gender category"}}}},"lineAges":{"type":"array","description":"LINE age demographics data (returned when platform is 'line' or not specified)","items":{"type":"object","properties":{"name":{"type":"string","description":"Age range in Chinese"},"percentage":{"type":"number","format":"float","description":"Percentage of users in this age range"}}}},"lineAreas":{"type":"array","description":"LINE area demographics data (returned when platform is 'line' or not specified)","items":{"type":"object","properties":{"name":{"type":"string","description":"Area name in Chinese"},"percentage":{"type":"number","format":"float","description":"Percentage of users in this area"}}}},"lineAppTypes":{"type":"array","description":"LINE app types data (returned when platform is 'line' or not specified)","items":{"type":"object","properties":{"name":{"type":"string","description":"App type name in Chinese"},"percentage":{"type":"number","format":"float","description":"Percentage of users using this app type"}}}},"lineMessageNumbers":{"type":"integer","description":"Number of LINE messages (returned when platform is 'line' or not specified)"},"lineIsIntegration":{"type":"boolean","description":"LINE integration status (returned when platform is 'line' or not specified)"},"lineTagCoverRate":{"type":"number","format":"float","description":"LINE tag coverage rate (returned when platform is 'line' or not specified)"},"fbFollowers":{"type":"integer","description":"Number of Facebook followers (returned when platform is 'facebook' or not specified)"},"fbBlocks":{"type":"integer","description":"Number of Facebook blocks (returned when platform is 'facebook' or not specified)"},"fbMessageNumbers":{"type":"integer","description":"Number of Facebook messages (returned when platform is 'facebook' or not specified)"},"fbIsIntegration":{"type":"boolean","description":"Facebook integration status (returned when platform is 'facebook' or not specified)"},"fbTagCoverRate":{"type":"number","format":"float","description":"Facebook tag coverage rate (returned when platform is 'facebook' or not specified)"},"igFollowers":{"type":"integer","description":"Number of Instagram followers (returned when platform is 'instagram' or not specified)"},"igMessageNumbers":{"type":"integer","description":"Number of Instagram messages (returned when platform is 'instagram' or not specified)"},"igIsIntegration":{"type":"boolean","description":"Instagram integration status (returned when platform is 'instagram' or not specified)"},"igTagCoverRate":{"type":"number","format":"float","description":"Instagram tag coverage rate (returned when platform is 'instagram' or not specified)"},"liveChatFollowers":{"type":"integer","description":"Number of LiveChat followers (returned when platform is 'liveChat' or not specified)"},"liveChatMessageNumbers":{"type":"integer","description":"Number of LiveChat messages (returned when platform is 'liveChat' or not specified)"},"liveChatIsIntegration":{"type":"boolean","description":"LiveChat integration status (returned when platform is 'liveChat' or not specified)"},"liveChatTagCoverRate":{"type":"number","format":"float","description":"LiveChat tag coverage rate (returned when platform is 'liveChat' or not specified)"},"whatsappFollowers":{"type":"integer","description":"Number of WhatsApp followers (returned when platform is 'whatsapp' or not specified)"},"whatsappMessageNumbers":{"type":"integer","description":"Number of WhatsApp messages (returned when platform is 'whatsapp' or not specified)"},"whatsappIsIntegration":{"type":"boolean","description":"WhatsApp integration status (returned when platform is 'whatsapp' or not specified)"},"whatsappTagCoverRate":{"type":"number","format":"float","description":"WhatsApp tag coverage rate (returned when platform is 'whatsapp' or not specified)"},"botTotallFollowers":{"type":"integer","description":"Total followers across all platforms (only returned when platform is not specified)"},"botTotallBlocks":{"type":"integer","description":"Total blocks across all platforms (only returned when platform is not specified)"},"botTotallMessages":{"type":"integer","description":"Total messages across all platforms (only returned when platform is not specified)"}}}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"errResponse":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer"},"botId":{"type":"string"}},"required":["message","code"]}},"required":["success","errResponse"]}},"responses":{"TokenError":{"description":"JWT token is invalid or expired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"PermissionError":{"description":"Permission denied - insufficient access rights","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"GetOpenApiError":{"description":"OpenAPI configuration not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimitError":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/openapi/clients/analysis":{"post":{"tags":["Core"],"summary":"Get client analysis","description":"Retrieve client analysis data including followers, blocks, message numbers, and tag coverage rates.\n\nPlatform filtering:\n- If platform is not specified, returns data for all platforms\n- If platform is specified, returns data only for that platform\n\nSupported platforms: line, facebook, instagram, liveChat, whatsapp","parameters":[{"name":"botId","in":"query","required":true,"schema":{"type":"string"},"description":"The bot ID for the API request"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAnalysisRequest"}}}},"responses":{"200":{"description":"Client analysis data retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAnalysisResponse"}}}},"401":{"$ref":"#/components/responses/TokenError"},"403":{"$ref":"#/components/responses/PermissionError"},"404":{"$ref":"#/components/responses/GetOpenApiError"},"429":{"$ref":"#/components/responses/RateLimitError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.mantago.cc/mantago-en/documentation-1/client-api/get-client-analytics.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
