> For the complete documentation index, see [llms.txt](https://docs.getlimy.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getlimy.ai/rest-api/api-reference/analytics.md).

# Analytics

## Brand mention trends

> Returns a time series of how often your brand and tracked competitors appear in AI search engine answers

```json
{"openapi":"3.0.0","info":{"title":"Limy API","version":"1.0"},"tags":[{"name":"analytics"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TimeSeriesRequestDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"filters":{"type":"object","properties":{"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"providers":{"type":"array","items":{"type":"string","enum":["GEMINI","OPENAI","ANTHROPIC","PERPLEXITY","GROK","GOOGLE_AI_MODE","GOOGLE_AI_OVERVIEW","COPILOT"]}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]}},"promptIds":{"description":"Restrict the metric to these prompts. Mutually exclusive with topics.","type":"array","items":{"type":"string","format":"uuid"}},"regions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code (case-insensitive). "}},"required":["code"]}},"branded":{"description":"Filter by branded prompts. Omit for all, true for branded-only, false for non-branded-only.","type":"boolean"}},"required":["timeRange"]}},"required":["interval","filters"]},"TimeSeriesResponseDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"series":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"value":{"type":"number","nullable":true}},"required":["timestamp","value"]}}},"required":["id","name","data"]}}},"required":["interval","timeRange","series"]}}},"paths":{"/v1/analytics/brands/mentions":{"post":{"description":"Returns a time series of how often your brand and tracked competitors appear in AI search engine answers","operationId":"AnalyticsController_getBrandsMentions","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesResponseDto"}}}}},"summary":"Brand mention trends","tags":["analytics"]}}}}
```

## Brand overall visibility trends

> Returns a time series of overall visibility (mentioned or cited) for your brand and tracked competitors in AI search engine answers

```json
{"openapi":"3.0.0","info":{"title":"Limy API","version":"1.0"},"tags":[{"name":"analytics"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TimeSeriesRequestDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"filters":{"type":"object","properties":{"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"providers":{"type":"array","items":{"type":"string","enum":["GEMINI","OPENAI","ANTHROPIC","PERPLEXITY","GROK","GOOGLE_AI_MODE","GOOGLE_AI_OVERVIEW","COPILOT"]}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]}},"promptIds":{"description":"Restrict the metric to these prompts. Mutually exclusive with topics.","type":"array","items":{"type":"string","format":"uuid"}},"regions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code (case-insensitive). "}},"required":["code"]}},"branded":{"description":"Filter by branded prompts. Omit for all, true for branded-only, false for non-branded-only.","type":"boolean"}},"required":["timeRange"]}},"required":["interval","filters"]},"TimeSeriesResponseDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"series":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"value":{"type":"number","nullable":true}},"required":["timestamp","value"]}}},"required":["id","name","data"]}}},"required":["interval","timeRange","series"]}}},"paths":{"/v1/analytics/brands/overall-visibility":{"post":{"description":"Returns a time series of overall visibility (mentioned or cited) for your brand and tracked competitors in AI search engine answers","operationId":"AnalyticsController_getBrandsOverallVisibility","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesResponseDto"}}}}},"summary":"Brand overall visibility trends","tags":["analytics"]}}}}
```

## Brand citation trends

> Returns a time series of how often your brand and tracked competitors are cited in AI search engine answers

```json
{"openapi":"3.0.0","info":{"title":"Limy API","version":"1.0"},"tags":[{"name":"analytics"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TimeSeriesRequestDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"filters":{"type":"object","properties":{"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"providers":{"type":"array","items":{"type":"string","enum":["GEMINI","OPENAI","ANTHROPIC","PERPLEXITY","GROK","GOOGLE_AI_MODE","GOOGLE_AI_OVERVIEW","COPILOT"]}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]}},"promptIds":{"description":"Restrict the metric to these prompts. Mutually exclusive with topics.","type":"array","items":{"type":"string","format":"uuid"}},"regions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code (case-insensitive). "}},"required":["code"]}},"branded":{"description":"Filter by branded prompts. Omit for all, true for branded-only, false for non-branded-only.","type":"boolean"}},"required":["timeRange"]}},"required":["interval","filters"]},"TimeSeriesResponseDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"series":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"value":{"type":"number","nullable":true}},"required":["timestamp","value"]}}},"required":["id","name","data"]}}},"required":["interval","timeRange","series"]}}},"paths":{"/v1/analytics/brands/citations":{"post":{"description":"Returns a time series of how often your brand and tracked competitors are cited in AI search engine answers","operationId":"AnalyticsController_getBrandsCitations","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesResponseDto"}}}}},"summary":"Brand citation trends","tags":["analytics"]}}}}
```

## Brand rank trends

> Returns a time series of your brand and tracked competitors ranking in AI search engine answers

```json
{"openapi":"3.0.0","info":{"title":"Limy API","version":"1.0"},"tags":[{"name":"analytics"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"TimeSeriesRequestDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"filters":{"type":"object","properties":{"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"providers":{"type":"array","items":{"type":"string","enum":["GEMINI","OPENAI","ANTHROPIC","PERPLEXITY","GROK","GOOGLE_AI_MODE","GOOGLE_AI_OVERVIEW","COPILOT"]}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]}},"promptIds":{"description":"Restrict the metric to these prompts. Mutually exclusive with topics.","type":"array","items":{"type":"string","format":"uuid"}},"regions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code (case-insensitive). "}},"required":["code"]}},"branded":{"description":"Filter by branded prompts. Omit for all, true for branded-only, false for non-branded-only.","type":"boolean"}},"required":["timeRange"]}},"required":["interval","filters"]},"TimeSeriesResponseDto":{"type":"object","properties":{"interval":{"type":"string","enum":["daily","weekly","monthly"]},"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"series":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"value":{"type":"number","nullable":true}},"required":["timestamp","value"]}}},"required":["id","name","data"]}}},"required":["interval","timeRange","series"]}}},"paths":{"/v1/analytics/brands/rank":{"post":{"description":"Returns a time series of your brand and tracked competitors ranking in AI search engine answers","operationId":"AnalyticsController_getBrandsRank","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeSeriesResponseDto"}}}}},"summary":"Brand rank trends","tags":["analytics"]}}}}
```

## Top cited sources

> Returns the domains or URLs most frequently cited in AI search answers for your account, ranked by citation volume

```json
{"openapi":"3.0.0","info":{"title":"Limy API","version":"1.0"},"tags":[{"name":"analytics"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SourceAnalysisRequestDto":{"type":"object","properties":{"limit":{"type":"integer","exclusiveMinimum":true,"maximum":100,"minimum":0},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991},"groupBy":{"type":"string","enum":["domain","url"]},"filters":{"type":"object","properties":{"timeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}},"required":["from","to"]},"providers":{"type":"array","items":{"type":"string","enum":["GEMINI","OPENAI","ANTHROPIC","PERPLEXITY","GROK","GOOGLE_AI_MODE","GOOGLE_AI_OVERVIEW","COPILOT"]}},"topics":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]}},"promptIds":{"description":"Restrict the metric to these prompts. Mutually exclusive with topics.","type":"array","items":{"type":"string","format":"uuid"}},"regions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$","description":"ISO 3166-1 alpha-2 country code (case-insensitive). "}},"required":["code"]}},"branded":{"description":"Filter by branded prompts. Omit for all, true for branded-only, false for non-branded-only.","type":"boolean"}},"required":["timeRange"]}},"required":["limit","offset","groupBy","filters"]},"SourceAnalysisResponseDto":{"type":"object","properties":{"groupBy":{"type":"string","enum":["domain","url"]},"sources":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"share":{"type":"number","minimum":0,"maximum":1},"citations":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["source","share","citations"]}},"pagination":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"limit":{"type":"integer","exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991},"hasMore":{"type":"boolean"}},"required":["total","limit","offset","hasMore"]}},"required":["groupBy","sources","pagination"]}}},"paths":{"/v1/analytics/sources":{"post":{"description":"Returns the domains or URLs most frequently cited in AI search answers for your account, ranked by citation volume","operationId":"AnalyticsController_getSourceAnalysis","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceAnalysisRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceAnalysisResponseDto"}}}}},"summary":"Top cited sources","tags":["analytics"]}}}}
```