AWorld Lab API Reference
API ReferenceApp API (Consumer)
Dashboard API (Admin)
API ReferenceApp API (Consumer)
Dashboard API (Admin)
  1. Streaks
  • ActivityLogs
    • Create activity log
    • List activity logs
    • Get activity log
  • Analytics
    • Get community metrics
  • Badges
    • List badge configurations
    • List badges
    • Get badge
    • List badge configuration tag assignments
    • Get badge configuration translation
    • Get badge configuration tag assignment
  • LearningGroups
    • List learning groups
    • Get learning group
    • List learning group items
    • List learning group tag assignments
    • Get learning group translation
    • Get learning group tag assignment
  • LearningPathAssignments
    • List learning path assignments
    • Get learning path assignment
    • Get current attempt
    • List learning path assignment items
    • Retry learning path assignment
    • List learning path assignment tags
    • Get learning path assignment translation
    • Get learning path assignment tag
  • Missions
    • List missions
    • Get mission
  • Quizzes
    • List quizzes
    • Get quiz
    • Submit quiz answer
    • List quiz tag assignments
    • Get quiz translation
    • Get quiz tag assignment
  • RuntimeLeaderboards
    • List runtime leaderboards
    • Get runtime leaderboard
    • Get leaderboard rankings
    • Get my ranking
  • Slides
    • List slides
    • Get slide
    • Submit slide progress
    • List slide tag assignments
    • Get slide translation
    • Get slide tag assignment
  • Streaks
    • List streaks
      GET
  • Users
    • Get current user
    • Update current user
    • Delete current user
    • List current user learning group logs
    • Get current user permissions
    • Get current user principal
    • Get current user referral code
    • Get current user stats
    • List current user tag assignments
    • Get current user tag assignment
  • VirtualBalances
    • List virtual balances
    • Get virtual balance
  • VirtualTransactions
    • List virtual transactions
    • Create virtual transaction
    • Get virtual transaction
    • Redeem virtual transaction
  • WorkspaceCodes
    • Redeem a workspace code
  • WorkspaceConfigurations
    • Get workspace configuration
  • Surveys
    • Get survey
    • Get survey progress
    • Submit survey answers
  • Schemas
    • CommunityMetricsResponse
    • CreateActivityResponse
    • CreateVirtualTransactionResponse
    • CurrentAttemptResponse
    • DeleteCurrentUserResponse
    • GetActivityLogResponse
    • GetBadgeConfigurationTagResponse
    • GetAppSurveyResponse
    • GetBadgeConfigurationTranslationResponse
    • GetBadgeResponse
    • GetCurrentUserPrincipalResponse
    • GetCurrentUserPermissionsResponse
    • GetCurrentUserReferralCodeResponse
    • GetCurrentUserResponse
    • GetCurrentUserStatsResponse
    • GetCurrentUserTagResponse
    • GetLearningGroupResponse
    • GetLearningGroupTagAssignmentResponse
    • GetLearningGroupTranslationResponse
    • GetLearningPathAssignmentResponse
    • GetLearningPathAssignmentTagResponse
    • GetLearningPathAssignmentTranslationResponse
    • GetMissionResponse
    • GetQuizResponse
    • GetQuizTagResponse
    • GetQuizTranslationResponse
    • GetRuntimeLeaderboardRankingsMeResponse
    • GetRuntimeLeaderboardRankingsResponse
    • GetRuntimeLeaderboardResponse
    • GetSlideResponse
    • GetSlideTagResponse
    • GetSlideTranslationResponse
    • GetVirtualBalanceResponse
    • GetVirtualTransactionResponse
    • GetWorkspaceConfigurationResponse
    • GetSurveyProgressResponse
    • JsonLogicExpression
    • Lang
    • ListActivityLogsResponse
    • ListBadgeConfigurationsResponse
    • ListBadgeConfigurationTagAssignmentsResponse
    • ListBadgesResponse
    • ListCurrentUserLearningGroupLogsResponse
    • ListCurrentUserTagAssignmentsResponse
    • ListLearningGroupItemsResponse
    • ListLearningGroupsResponse
    • ListLearningGroupTagAssignmentsResponse
    • ListLearningPathAssignmentItemsResponse
    • ListLearningPathAssignmentsResponse
    • ListLearningPathAssignmentTagsResponse
    • ListMissionsResponse
    • ListQuizTagAssignmentsResponse
    • ListQuizzesResponse
    • ListRuntimeLeaderboardsResponse
    • ListSlidesResponse
    • ListSlideTagAssignmentsResponse
    • ListStreaksResponse
    • ListVirtualBalancesResponse
    • ListVirtualTransactionsResponse
    • RedeemVirtualTransactionResponse
    • RedeemWorkspaceCodeResponse
    • RetryLearningPathAssignmentResponse
    • SourceRegion
    • SubmitQuizResponse
    • SubmitSlideResponse
    • Timezone
    • UpdateCurrentUserResponse
    • SubmitSurveyResponse
  1. Streaks

List streaks

GET
/streaks
Streaks
Retrieves a paginated list of user streaks with configuration details. Supports filtering by period type, date range, and optional field resolution for translations.

Request

Query Params

Responses

🟢200OK
application/json
Streaks retrieved successfully
Body

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/streaks?fields&from&goalId&iterationId&limit&nextToken&order&periodType&sort&streakRuleId&target&to'
Response Response Example
{
    "items": [
        {
            "streakId": "string",
            "userId": "string",
            "streakRuleId": "string",
            "periodId": "string",
            "status": "ACTIVE",
            "kind": "REGULAR",
            "cadence": "DAY",
            "metric": "DAYS",
            "count": 0,
            "periodType": "DAY",
            "iterationId": 1,
            "goalId": 1,
            "target": 1,
            "perfectWeek": true,
            "perfectMonth": true,
            "perfectYear": true,
            "lastContributingDay": "string",
            "timezone": "UTC",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "streakConfiguration": {
                "streakConfigurationId": "string",
                "name": "string",
                "description": "string",
                "matchType": "INSTANCE",
                "matchEntity": "Mission",
                "matchEntityId": "string",
                "matchCondition": {
                    "==": [
                        1,
                        1
                    ]
                },
                "origin": "CATALOG",
                "streakConfigurationCatalogId": "string",
                "syncWithCatalog": true,
                "defaultLang": "en",
                "langs": [
                    "en"
                ],
                "icon": "http://example.com",
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            },
            "translation": {
                "lang": "en",
                "label": "string",
                "description": "string"
            }
        }
    ],
    "nextToken": "eyJwayI6IndvcmtzcGFjZUlkI3pPR0JndVctQWoiLCJxdWl6SWQiOiItRktBdDZfbXM4M3RvSUZaLWVjeFQifQ=="
}
Modified at 2026-04-02 15:44:17
Previous
Get slide tag assignment
Next
Get current user
Built with