Where a dashboard label differs from the name in the API, both are given, for example the dashboard’s Where your users’ data is visible is the API setting
data_scope.Start page
The first page of the CabalSpy ID tab sums up all your instances over the last 30 days. It has no settings, only figures and shortcuts.Instances page
Lists your instances with their logo, Instance ID, mode, number of users and domain. The mode is one of DEVELOPMENT, SANDBOX, IN REVIEW or LIVE, see Instance modes. Create an instance asks for:
After creating a server-side app, the dashboard shows its first client secret once, on the Credentials tab.
Sandbox
Sandbox on the start page lets you call every CabalSpy ID endpoint live with your own API key and copy ready-to-run code. Pick an endpoint, fill in its parameters or JSON body and press Send request; Reset restores the example values. Only API keys with CabalSpy ID switched on are offered, see API keys. The sandbox page is a request tool for the Data API. It is not the same as an instance in sandbox mode.Instance tabs
Overview
When a live instance reaches 80 percent of its user limit, and again at 100 percent, the instance page shows a banner and you receive an e-mail.
Users & stats
Credentials
See Clients and Authentication.
Login button
The design every embedded login button of this instance uses.data-* attributes on an element override single values, see Attributes. Save design stores it; the preview shows the saved design.
Profile page on your site is where View profile in the signed-in menu goes, for example
https://yourplatform.xyz/u/{username}. Left empty, it opens the person’s CabalSpy ID profile. Settings in the menu always opens CabalSpy ID. See Signed-in menu.
The Embed box shows the two lines of HTML for your instance: with data-href for server-side apps, without it for browser apps.
Theses
The design and reach of the thesis widget for every embed with this instance’sdata-client-id. data-* attributes on an element override single values. Save design stores it; the live preview updates as you type but is not saved until you save.
Reset colours to theme puts all colours back to the defaults of the chosen theme; changing the theme does the same. Only this instance also applies to the Data API and the theses stream when you pass
scope=instance, see Reach.
The tab also shows thesis statistics, the most discussed tokens and the latest theses on this instance. Reports and moderation are handled by CabalSpy. To let people signed in with your login button write theses directly, request the thesis scope in Settings.
White-label
Settings for the users your platform manages through the API by your own user id, see White-Label. If the box shows a warning instead, CabalSpy ID could not be reached. Platform users shows how many platform users the instance has, how many took their account into their own CabalSpy ID and the free places for new users. Sandbox and development instances hold up to 25 platform users; live instances count against the plan of their domain, where every user on the domain counts. When no place is left, new users are refused withplan_user_limit and existing ones keep working. See Plan limits.
White-label settings apply at once when you press Save settings. They are the same settings as GET and POST /v1/platform-users/settings.
The dashboard always saves all six settings together. After the first save,
claim_links keeps the value of its checkbox and no longer follows white_label.
While it is on, the box shows ON and the time of the last event received.
Competitions
Trading competitions between your platform users. The tab lists your competitions with status, metric, participants, end time and rules version (CHANGED marks rules that were changed while running). You can run 5 at a time across all your instances, the box shows how many are open. Open a competition to see its standings (top entries; unranked traders below the minimums show –), its rule changes and, while it is scheduled, waiting or running, the forms to change or cancel it. New competition creates one, the same as POST /v1/competitions:
When 5 competitions are open, the form is replaced by a notice. End or cancel one first.
Change the rules edits a scheduled, waiting or running competition, the same as POST /v1/competitions/update. The form covers name, metric, duration, min. and max. participants, min. trades, min. volume, wallets and late join, plus an optional Note for the change log (up to 500 characters). Every change raises the rules version, is listed under Rule changes with the time and phase and is sent as the
competition.updated webhook. Chain, participants mode, start time, description and prizes can only be changed through the API.
Cancel competition cancels it for good, the same as POST /v1/competitions/cancel, and sends competition.ended with cancelled: true.
Settings
Each box has its own save button. Scopes added later show the consent screen again to people who already signed in.
Domains and testers
The dashboard calls this tab Domains & testers. Domains proves that you own your platform’s domain. A verified domain is needed to go live and carries your plan: the main domain of your first verified domain (for exampleexample.com for app.example.com) belongs to your account, and nobody else can add it.
Testers (not shown for sandbox instances): while an instance is in development, only you and these people can sign in. Add up to 25 by their X handle; they need a CabalSpy ID first. Anyone else gets
access_denied. Remove takes a tester off the list.
Webhooks
Activity
A log of changes to the instance: when, what, details and the IP address they came from. It has no settings.API keys
The API keys page of the dashboard is shared by all products. For each key you choose which APIs it may call: the CabalSpy API, CabalSpy ID or both. A key needs at least one. Only keys with CabalSpy ID switched on can call the Data API, others getproduct_not_enabled, and only they are offered in the sandbox. Changes reach CabalSpy ID within about 30 seconds.