> For the complete documentation index, see [llms.txt](https://pixyleai.gitbook.io/pixyle.ai-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pixyleai.gitbook.io/pixyle.ai-documentation/api-endpoints/analytics/routes.md).

# Routes

## Get analytics data

> Retrieves comprehensive analytics data for the authenticated client including:\
> \
> \- \*\*Time Series Features Data\*\*: Processing metrics broken down by feature over time\
> \- \*\*Time Series Overall Data\*\*: Aggregate processing metrics over time\
> \- \*\*Overall Data\*\*: Summary statistics including processing times and efficiency metrics\
> \- \*\*Verification Data\*\*: Data quality and verification statistics\
> \
> The endpoint supports flexible date range queries with automatic interval selection:\
> \- For date ranges ≤ 1 day: 1-hour intervals\
> \- For date ranges > 1 day: 1-day intervals\
> \
> \*\*Date Range Options:\*\*\
> \- Use \`start\_date\` and \`end\_date\` parameters for custom ranges\
> \- Use \`last\_24h=true\` for the most recent 24 hours\
> \- Date ranges are automatically limited to client creation date and current date\
> \
> \*\*Rate limits:\*\*\
> \- 100 requests/minute<br>

```json
{"openapi":"3.0.3","info":{"title":"Analytics API","version":"1.0.0"},"servers":[{"url":"https://api.pixyle.ai/main/v1"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AnalyticsResponse":{"type":"object","description":"Complete analytics data response","properties":{"time_series_features_data":{"type":"array","description":"Processing metrics broken down by feature over time","items":{"$ref":"#/components/schemas/TimeSeriesFeatureData"}},"time_series_overall_data":{"type":"array","description":"Aggregate processing metrics over time","items":{"$ref":"#/components/schemas/TimeSeriesOverallData"}},"overall_data":{"$ref":"#/components/schemas/OverallData"},"verification_data":{"$ref":"#/components/schemas/VerificationData"}}},"TimeSeriesFeatureData":{"type":"object","description":"Feature-specific processing metrics for a specific time period","properties":{"timestamp":{"type":"string","format":"date","description":"Date or timestamp for this data point"},"feature_name":{"type":"string","description":"Name of the feature (e.g., automatic_tagging, title_generation)"},"processed_listings_count":{"type":"integer","description":"Number of listings processed by this feature"},"data_points_count":{"type":"integer","description":"Total number of data points generated by this feature"},"processing_time_seconds":{"type":"number","format":"float","description":"Time taken to process listings for this feature in seconds"}}},"TimeSeriesOverallData":{"type":"object","description":"Aggregate processing metrics for a specific time period","properties":{"timestamp":{"type":"string","format":"date","description":"Date or timestamp for this data point"},"upload_listings_count":{"type":"integer","description":"Number of listings uploaded"},"processed_listings_count":{"type":"integer","description":"Number of listings successfully processed"},"processed_images_count":{"type":"integer","description":"Number of images processed"},"data_points_count":{"type":"integer","description":"Total number of data points generated across all features"},"processing_time_seconds":{"type":"number","format":"float","description":"Total processing time in seconds"}}},"OverallData":{"type":"object","description":"Summary statistics for the entire date range","properties":{"manual_avg_processing_time":{"type":"number","format":"float","description":"Estimated time it would take to manually process all data points"},"ai_processing_time":{"type":"number","format":"float","description":"Actual AI processing time in seconds"},"processed_listings_count":{"type":"integer","description":"Total number of listings processed in the date range"},"processed_images_count":{"type":"integer","description":"Total number of images processed in the date range"},"data_points_count":{"type":"integer","description":"Total number of data points generated in the date range"},"time_saved":{"type":"number","format":"float","description":"Time saved by using AI vs manual processing (manual_time - ai_time)"}}},"VerificationData":{"type":"object","description":"Data quality and verification statistics","properties":{"verified_products_count":{"type":"integer","description":"Number of products that have been verified"},"verified_data_points_count":{"type":"integer","description":"Number of data points that have been verified"},"verified_data_points_percentage":{"type":"number","format":"float","description":"Percentage of total data points that have been verified"},"correct_data_points_count":{"type":"integer","description":"Number of verified data points that were marked as correct"},"correct_data_points_percentage":{"type":"number","format":"float","description":"Percentage of verified data points that were correct"},"updated_data_points":{"$ref":"#/components/schemas/UpdatedDataPoints"}}},"UpdatedDataPoints":{"type":"object","description":"Statistics about data point modifications during verification","properties":{"added_data_points_count":{"type":"integer","description":"Number of data points added during verification"},"modified_data_points_count":{"type":"integer","description":"Number of data points modified during verification"},"deleted_data_points_count":{"type":"integer","description":"Number of data points deleted during verification"}}},"ErrorResponse":{"type":"object","description":"Standard error response format","properties":{"message":{"type":"string","description":"Human-readable error message"},"code":{"type":"integer","description":"HTTP status code"},"detail":{"type":"object","description":"Additional error details","additionalProperties":true}}}}},"paths":{"/analytics":{"get":{"summary":"Get analytics data","description":"Retrieves comprehensive analytics data for the authenticated client including:\n\n- **Time Series Features Data**: Processing metrics broken down by feature over time\n- **Time Series Overall Data**: Aggregate processing metrics over time\n- **Overall Data**: Summary statistics including processing times and efficiency metrics\n- **Verification Data**: Data quality and verification statistics\n\nThe endpoint supports flexible date range queries with automatic interval selection:\n- For date ranges ≤ 1 day: 1-hour intervals\n- For date ranges > 1 day: 1-day intervals\n\n**Date Range Options:**\n- Use `start_date` and `end_date` parameters for custom ranges\n- Use `last_24h=true` for the most recent 24 hours\n- Date ranges are automatically limited to client creation date and current date\n\n**Rate limits:**\n- 100 requests/minute\n","tags":["Analytics"],"parameters":[{"name":"start_date","in":"query","description":"Start date for analytics data in YYYY-MM-DD format","required":false,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"End date for analytics data in YYYY-MM-DD format","required":false,"schema":{"type":"string","format":"date"}},{"name":"last_24h","in":"query","description":"Get analytics for the last 24 hours (overrides start_date and end_date)","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Analytics data retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsResponse"}}}},"400":{"description":"Bad request - Invalid date format or invalid date range","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```