Skip to main content
GET
/
leaderboards
/
configs
Get paginated leaderboard configurations
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/leaderboards/configs \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "name": "<string>",
      "metricType": "total-xp",
      "period": "daily",
      "startsAt": "<string>",
      "status": "archived",
      "conditions": [
        {
          "type": "community",
          "communityId": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "reward": [
        {
          "startRank": 123,
          "endRank": 123,
          "points": 1,
          "completionXp": 1,
          "items": [
            {
              "id": "<string>",
              "organisationId": "<string>",
              "communityId": "<string>",
              "additionalCommunityIds": [
                "<string>"
              ],
              "details": {
                "title": "<string>",
                "description": "<string>",
                "light": {
                  "primaryImageUrl": "<string>",
                  "secondaryImageUrl": "<string>"
                },
                "dark": {
                  "primaryImageUrl": "<string>",
                  "secondaryImageUrl": "<string>"
                }
              },
              "assetPointsPrice": 1,
              "assetPointsSwapValue": 1,
              "entryPointsPrice": 1,
              "assetsSupply": 1,
              "entriesSupply": 1,
              "maxAssetsPerUser": 2,
              "maxEntriesPerUser": 2,
              "allocationsType": "assets-only",
              "isSharedAssetsSupply": true,
              "isSharedEntriesSupply": true,
              "allocations": [
                {
                  "id": "<string>",
                  "allocationType": "assets",
                  "supply": 1,
                  "amountToDistribute": 2,
                  "distributed": 1,
                  "isShop": true,
                  "isLive": true
                }
              ],
              "redemptionConfig": {
                "type": "rich-text",
                "additionalInformation": [
                  {
                    "variableConfigId": "<string>",
                    "required": true,
                    "position": 2
                  }
                ],
                "autoRedeem": false,
                "content": "<string>",
                "instructions": "<string>",
                "instructionsImageUrl": "<string>",
                "supportEmail": "jsmith@example.com",
                "supportPhoneNumber": "<string>",
                "supportUrl": "<string>",
                "redeemByDate": "<string>"
              },
              "tags": [
                {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "value": "<string>",
                  "config": {
                    "filtering": [
                      "achievement"
                    ],
                    "display": [
                      "achievement"
                    ],
                    "iconifyIcon": "<string>"
                  },
                  "createdAt": "<string>",
                  "updatedAt": "<string>"
                }
              ],
              "campaigns": [
                {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "name": "<string>",
                  "startDate": "<string>",
                  "endDate": "<string>",
                  "status": "archived",
                  "createdAt": "<string>",
                  "updatedAt": "<string>"
                }
              ],
              "status": "archived",
              "isManualGiveaway": true,
              "availableAsTemplateForOrganisations": [
                "<string>"
              ],
              "isGlobalTemplate": true,
              "metadata": {},
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "community": {
                "id": "<string>",
                "name": "<string>",
                "slug": "<string>",
                "descriptionConfig": {
                  "content": "<string>",
                  "disableLineClamp": true,
                  "maxLines": 5.5
                },
                "logo": "<string>"
              },
              "challenges": [
                {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "communityId": "<string>",
                  "additionalCommunityIds": [
                    "<string>"
                  ],
                  "details": {
                    "title": "<string>",
                    "description": "<string>",
                    "light": {
                      "primaryImageUrl": "<string>",
                      "secondaryImageUrl": "<string>"
                    },
                    "dark": {
                      "primaryImageUrl": "<string>",
                      "secondaryImageUrl": "<string>"
                    }
                  },
                  "progressPeriod": "daily",
                  "maxCompletionsPerPeriod": 1,
                  "numberOfActions": 1,
                  "actionIds": [
                    "<string>"
                  ],
                  "actionGroups": [
                    {
                      "id": "<string>",
                      "type": "single",
                      "details": {
                        "title": "<string>",
                        "description": "<string>",
                        "light": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        },
                        "dark": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        }
                      },
                      "parentGroupId": "<string>",
                      "displayType": "list"
                    }
                  ],
                  "status": "archived",
                  "isLinear": true,
                  "unlockPrice": 1,
                  "tags": [
                    {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "value": "<string>",
                      "config": {
                        "filtering": [
                          "achievement"
                        ],
                        "display": [
                          "achievement"
                        ],
                        "iconifyIcon": "<string>"
                      },
                      "createdAt": "<string>",
                      "updatedAt": "<string>"
                    }
                  ],
                  "startedCount": 1,
                  "completedCount": 1,
                  "uniqueUsersStartedCount": 1,
                  "uniqueUsersCompletedCount": 1,
                  "campaigns": [
                    {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "name": "<string>",
                      "startDate": "<string>",
                      "endDate": "<string>",
                      "status": "archived",
                      "createdAt": "<string>",
                      "updatedAt": "<string>"
                    }
                  ],
                  "availableAsTemplateForOrganisations": [
                    "<string>"
                  ],
                  "isGlobalTemplate": true,
                  "groupIds": [
                    "<string>"
                  ],
                  "createdAt": "<string>",
                  "videoConfig": {
                    "videoUrl": "<string>",
                    "isVideoEnabled": true
                  },
                  "xpConfig": {
                    "total": 1,
                    "knowledge": 1,
                    "creativity": 1,
                    "loyalty": 1,
                    "influence": 1,
                    "participation": 1,
                    "contribution": 1
                  },
                  "rewardDistribution": {
                    "points": 1,
                    "xp": 1,
                    "rewardSelectionMethod": "all",
                    "distributionEventId": "<string>",
                    "rewardAllocations": [
                      {
                        "rewardId": "<string>",
                        "allocationId": "<string>",
                        "allocationType": "assets",
                        "amountToDistribute": 2
                      }
                    ],
                    "numberOfRewardsToReceive": 1
                  },
                  "actionsRewardDistribution": {
                    "points": 1,
                    "xp": 1,
                    "rewardAllocations": [
                      {
                        "rewardId": "<string>",
                        "allocationId": "<string>",
                        "allocationType": "assets",
                        "amountToDistribute": 2
                      }
                    ]
                  },
                  "actions": [
                    {
                      "id": "<string>",
                      "organisationId": "<string>",
                      "communityId": "<string>",
                      "allocationId": "<string>",
                      "allocatedTo": "achievement",
                      "position": 123,
                      "category": "nudj",
                      "key": "facebook-comment",
                      "details": {
                        "title": "<string>",
                        "description": "<string>",
                        "light": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        },
                        "dark": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        }
                      },
                      "progressPeriod": "daily",
                      "maxCompletionsPerPeriod": 1,
                      "attributes": {
                        "key": "question-multiple-choice",
                        "question": "<string>",
                        "options": [
                          {
                            "id": "<string>",
                            "label": "<string>"
                          }
                        ],
                        "minimumNumberOfAnswersRequired": 2,
                        "maximumNumberOfAnswersAllowed": 2
                      },
                      "config": {
                        "isOptional": true,
                        "socialValidation": "validation-on",
                        "prerequisites": {
                          "requiredActionCount": 123,
                          "actionIds": [
                            "<string>"
                          ]
                        },
                        "requiresCorrectAnswer": true
                      },
                      "xpConfig": {
                        "total": 1,
                        "knowledge": 1,
                        "creativity": 1,
                        "loyalty": 1,
                        "influence": 1,
                        "participation": 1,
                        "contribution": 1
                      },
                      "videoMetadata": {
                        "startsAtMs": 1,
                        "shouldPause": true,
                        "validatesAtMs": 1,
                        "endsAtMs": 1
                      },
                      "createdAt": "<string>",
                      "rewardDistribution": {
                        "points": 1,
                        "xp": 1,
                        "rewardSelectionMethod": "all",
                        "distributionEventId": "<string>",
                        "rewardAllocations": [
                          {
                            "rewardId": "<string>",
                            "allocationId": "<string>",
                            "allocationType": "assets",
                            "amountToDistribute": 2
                          }
                        ],
                        "numberOfRewardsToReceive": 1
                      },
                      "rewards": [
                        {
                          "id": "<string>",
                          "details": {
                            "title": "<string>",
                            "description": "<string>",
                            "light": {
                              "primaryImageUrl": "<string>",
                              "secondaryImageUrl": "<string>"
                            },
                            "dark": {
                              "primaryImageUrl": "<string>",
                              "secondaryImageUrl": "<string>"
                            }
                          },
                          "type": "assets",
                          "amountToDistribute": 1,
                          "totalSupply": 1,
                          "remainingSupply": 1
                        }
                      ],
                      "userState": {
                        "status": "abandoned",
                        "criteriaMet": true,
                        "statusMessage": "<string>",
                        "eligibleXp": 123,
                        "earnedXp": 123,
                        "attempts": 123,
                        "output": {
                          "key": "interaction-external-link",
                          "eventId": "<string>"
                        },
                        "unmetCriteriaMessage": "<string>",
                        "metCriteriaMessage": "<string>"
                      },
                      "participations": [
                        {
                          "id": "<string>",
                          "criteriaMet": true,
                          "output": {
                            "key": "interaction-external-link",
                            "eventId": "<string>"
                          },
                          "status": "pending",
                          "participatedAt": "<string>",
                          "processingStartedAt": "<string>",
                          "processedAt": "<string>",
                          "unmetCriteriaMessage": "<string>",
                          "metCriteriaMessage": "<string>",
                          "processingFailedMessage": "<string>"
                        }
                      ],
                      "actionGroupId": "<string>",
                      "actionGroupIndex": 123,
                      "availableAsTemplateForOrganisations": [
                        "<string>"
                      ],
                      "isGlobalTemplate": true,
                      "previousAction": "<string>",
                      "nextAction": "<string>"
                    }
                  ],
                  "rewards": [
                    {
                      "id": "<string>",
                      "details": {
                        "title": "<string>",
                        "description": "<string>",
                        "light": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        },
                        "dark": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        }
                      },
                      "type": "assets",
                      "amountToDistribute": 1,
                      "totalSupply": 1,
                      "remainingSupply": 1
                    }
                  ],
                  "userState": {
                    "status": "abandoned",
                    "completionsInPeriod": 0,
                    "totalCompletions": 0,
                    "keysContributed": 0,
                    "latestAttempt": {
                      "eligibleXp": 0,
                      "actionsCompletedCount": 0,
                      "earnedXp": 0,
                      "earnedPoints": 0,
                      "earnedRewardAssets": [
                        {
                          "rewardAssetId": "<string>",
                          "rewardId": "<string>"
                        }
                      ],
                      "earnedRewardEntries": [
                        {
                          "rewardEntryId": "<string>",
                          "rewardId": "<string>",
                          "amount": 1
                        }
                      ],
                      "completionTime": 0,
                      "successRate": 0,
                      "startedAt": "<string>"
                    },
                    "historicAttempts": [],
                    "challengeProgressId": "<string>"
                  },
                  "challengeType": "survey",
                  "enabledForSingleView": true,
                  "startDate": "<string>",
                  "endDate": "<string>",
                  "featured": true,
                  "threadId": "<string>",
                  "isSkippable": true,
                  "startsAt": "<string>",
                  "expiresAt": "<string>",
                  "updatedAt": "<string>",
                  "community": {
                    "id": "<string>",
                    "name": "<string>",
                    "slug": "<string>",
                    "descriptionConfig": {
                      "content": "<string>",
                      "disableLineClamp": true,
                      "maxLines": 5.5
                    },
                    "logo": "<string>"
                  }
                }
              ],
              "achievements": [
                {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "details": {
                    "title": "<string>",
                    "description": "<string>",
                    "light": {
                      "primaryImageUrl": "<string>",
                      "secondaryImageUrl": "<string>"
                    },
                    "dark": {
                      "primaryImageUrl": "<string>",
                      "secondaryImageUrl": "<string>"
                    }
                  },
                  "progressPeriod": "daily",
                  "displayMode": "default",
                  "tags": [
                    "<string>"
                  ],
                  "campaigns": [
                    "<string>"
                  ],
                  "criteria": {
                    "type": "sum",
                    "parameters": {
                      "query": "<string>",
                      "operator": "==",
                      "attribute": "<string>",
                      "value": 123
                    }
                  },
                  "queries": [
                    {
                      "type": "event",
                      "alias": "<string>",
                      "parameters": {
                        "eventName": "<string>",
                        "eventCategory": "achievement",
                        "eventSubCategory": "achievement-completion",
                        "eventSourceId": "<string>",
                        "tags": [
                          "<string>"
                        ]
                      },
                      "isCommunityScoped": true
                    }
                  ],
                  "queryDescriptions": {},
                  "status": "archived",
                  "availableAsTemplateForOrganisations": [
                    "<string>"
                  ],
                  "isGlobalTemplate": true,
                  "createdAt": "<string>",
                  "updatedAt": "<string>",
                  "rewardDistribution": {
                    "points": 1,
                    "xp": 1,
                    "rewardSelectionMethod": "all",
                    "distributionEventId": "<string>",
                    "rewardAllocations": [
                      {
                        "rewardId": "<string>",
                        "allocationId": "<string>",
                        "allocationType": "assets",
                        "amountToDistribute": 2
                      }
                    ],
                    "numberOfRewardsToReceive": 1
                  },
                  "userState": {
                    "status": "abandoned",
                    "timesCompleted": 1,
                    "isClaimable": true,
                    "isClaimed": true,
                    "updatedAt": "<string>",
                    "earnedPoints": 1,
                    "earnedRewardAssets": [
                      {
                        "rewardAssetId": "<string>",
                        "rewardId": "<string>"
                      }
                    ],
                    "earnedRewardEntries": [
                      {
                        "rewardEntryId": "<string>",
                        "rewardId": "<string>",
                        "amount": 1
                      }
                    ],
                    "earnedXp": 1,
                    "type": "sum",
                    "isComplete": true,
                    "currentValue": 123,
                    "targetValue": 123,
                    "conditions": "<array>",
                    "completedAt": "<string>",
                    "progressResetsAt": "<string>"
                  },
                  "stats": {
                    "completedCount": 1
                  },
                  "rewards": [
                    {
                      "id": "<string>",
                      "details": {
                        "title": "<string>",
                        "description": "<string>",
                        "light": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        },
                        "dark": {
                          "primaryImageUrl": "<string>",
                          "secondaryImageUrl": "<string>"
                        }
                      },
                      "type": "assets",
                      "amountToDistribute": 1,
                      "totalSupply": 1,
                      "remainingSupply": 1
                    }
                  ],
                  "communityId": "<string>",
                  "featured": true,
                  "startsAt": "<string>",
                  "expiresAt": "<string>",
                  "community": {
                    "id": "<string>",
                    "name": "<string>",
                    "slug": "<string>",
                    "descriptionConfig": {
                      "content": "<string>",
                      "disableLineClamp": true,
                      "maxLines": 5.5
                    },
                    "logo": "<string>"
                  }
                }
              ],
              "initialAssetSupply": 1,
              "initialEntrySupply": 1,
              "distributedAssetCount": 1,
              "distributedEntryCount": 1,
              "remainingAssetSupply": 1,
              "remainingEntrySupply": 1,
              "remainingShopAssetSupply": 1,
              "remainingShopEntrySupply": 1,
              "userEntryCount": 0,
              "userAssetCount": 0,
              "featured": true,
              "drawsAt": "<string>",
              "startsAt": "<string>",
              "expiresAt": "<string>"
            }
          ],
          "rewardSelectionMethod": "all",
          "numberOfRewardsToReceive": 1
        }
      ],
      "description": "<string>",
      "expiresAt": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

The language to return the leaderboards in. If not provided, the default language for the organisation will be used.

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0
sort
string
communityId
string
allocationId
string
verified
boolean
isShop
boolean
type
string
status
string
eventCategory
string
eventSubCategory
string
eventName
string
displayMode
string
fromDate
string
toDate
string
isGlobalTemplate
boolean
key
string
progressPeriod
string
expand
string
redeemableType
string

Response

Successful response

totalCount
number
required
edges
object[]
required