> ## Documentation Index > Fetch the complete documentation index at: https://docs.habitify.me/llms.txt > Use this file to discover all available pages before exploring further. # Get habit statistics > Retrieve aggregated statistics for a specific habit within an optional date range. Includes completion counts, skip and failure counts, total logged values, and an optional daily progress breakdown. ## OpenAPI ````yaml https://static.habitify.me/Habitify%20API%20v2.json get /habits/{habitId}/statistics openapi: 3.1.1 info: title: Habitify API v2 description: > Welcome to our REST API. Use it to programmatically access your habit tracking data, build integrations, and automate workflows. ## Authentication All endpoints require authentication using an API key passed in the `X-API-Key` header. To generate your API key, open our app and go to **Settings > API**. Only one API key can be active at a time — generating a new key automatically revokes the previous one. > **Note:** API access requires a paid subscription and is not available on the free plan. ### Example Request ``` curl -X GET https://api.habitify.me/v2/habits \ -H "X-API-Key: YOUR_API_KEY" ``` ## Rate Limiting We enforce a rate limit of **500 requests per minute** per account. If you exceed this limit, we will respond with a `429 Too Many Requests` status code. Wait for the rate limit window to reset before making additional requests. ## Versioning This is version 2 of our API. All endpoints are prefixed with `/v2`. version: 2.0.0 contact: name: Habitify API Support url: https://habitify.me license: name: Proprietary url: https://habitify.me/terms servers: - url: https://api.habitify.me/v2 description: Production server security: - ApiKeyTokenAuth: [] - AccessTokenAuth: [] - IdTokenAuth: [] tags: - name: Habits description: Manage your habits — create, update, archive, and delete them x-scalar-order: - habitify-api-v2/tag/habits/GET/habits - habitify-api-v2/tag/habits/POST/habits - habitify-api-v2/tag/habits/GET/habits/journal - habitify-api-v2/tag/habits/GET/habits/{habitId} - habitify-api-v2/tag/habits/PUT/habits/{habitId} - habitify-api-v2/tag/habits/DELETE/habits/{habitId} - habitify-api-v2/tag/habits/POST/habits/{habitId}/archive - habitify-api-v2/tag/habits/GET/habits/{habitId}/statistics - name: Habit Logs description: >- Track your progress by logging completions, failures, skips, and measured values x-scalar-order: - habitify-api-v2/tag/habit-logs/POST/habits/{habitId}/logs - habitify-api-v2/tag/habit-logs/DELETE/habits/{habitId}/logs/{logId} - habitify-api-v2/tag/habit-logs/POST/habits/{habitId}/logs/complete - habitify-api-v2/tag/habit-logs/POST/habits/{habitId}/logs/failed - habitify-api-v2/tag/habit-logs/POST/habits/{habitId}/logs/skipped - habitify-api-v2/tag/habit-logs/POST/habits/{habitId}/logs/undo - name: Habit Notes description: Attach notes with text, mood levels, and photos to your habits x-scalar-order: - habitify-api-v2/tag/habit-notes/GET/habits/{habitId}/notes - habitify-api-v2/tag/habit-notes/POST/habits/{habitId}/notes - habitify-api-v2/tag/habit-notes/PUT/habits/{habitId}/notes/{noteId} - habitify-api-v2/tag/habit-notes/DELETE/habits/{habitId}/notes/{noteId} - name: Areas description: Organize your habits into areas for grouping and categorization x-scalar-order: - habitify-api-v2/tag/areas/GET/areas - habitify-api-v2/tag/areas/POST/areas - habitify-api-v2/tag/areas/GET/areas/{areaId} - habitify-api-v2/tag/areas/PUT/areas/{areaId} - habitify-api-v2/tag/areas/DELETE/areas/{areaId} paths: /habits/{habitId}/statistics: get: tags: - Habits summary: Get habit statistics description: >- Retrieve aggregated statistics for a specific habit within an optional date range. Includes completion counts, skip and failure counts, total logged values, and an optional daily progress breakdown. parameters: - name: habitId in: path required: true schema: type: string description: The unique identifier of the habit - name: startDate in: query required: false schema: type: string format: date description: >- Start date for the statistics range (YYYY-MM-DD format). Defaults to the habit's start date. - name: endDate in: query required: false schema: type: string format: date description: >- End date for the statistics range (YYYY-MM-DD format). Defaults to today. responses: '200': description: Aggregated habit statistics for the requested period content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: Unique identifier of the habit name: type: string description: Display name of the habit type: type: string description: Habit type (good or bad) totalLogs: type: number description: Sum of all logged values within the period skips: type: integer description: Number of days the habit was skipped fails: type: integer description: Number of days the habit was marked as failed completions: type: integer description: Number of days the habit was completed successfully unit: type: object description: Unit of measurement for the habit's logged values properties: id: type: string description: Unique identifier of the unit name: type: string description: Display name of the unit symbol: type: string description: Symbol for the unit (e.g., "km", "min") periodicity: type: string description: Goal periodicity of the habit avg: type: number description: Average logged value per day within the period dailyProgress: type: array description: Day-by-day progress breakdown items: type: object properties: date: type: string format: date description: Date of the entry (YYYY-MM-DD format) totalLog: type: number description: Total value logged for this date status: type: string enum: - completed - failed - skipped - inprogress description: Completion status of the habit for this date '400': description: Bad request - invalid query parameters '401': description: Unauthorized - missing or invalid authentication '404': description: Habit not found components: securitySchemes: ApiKeyTokenAuth: type: apiKey in: header name: X-API-Key description: >- API key generated from our app (Settings > API). Only one key can be active at a time. AccessTokenAuth: type: http scheme: bearer bearerFormat: JWT description: Access token acquired from OAuth2 IdTokenAuth: type: http scheme: bearer bearerFormat: JWT description: ID token from Firebase Auth ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.