Dashboard Guide

The SteamData Connect Dashboard is your central hub for managing teams, viewing analytics, and configuring APIs. This guide will help you make the most of all Dashboard features.

Overview

The Dashboard provides the following core features:

  • Team Management - Create and manage teams, invite members to collaborate
  • API Key Management - Generate and manage Connect API keys
  • Steam Data Configuration - Configure Steam Financial API to fetch sales data
  • Data Analytics - View game sales data and trend analysis (coming soon)
  • Personal Settings - Manage your account information and preferences

Team Management

Creating a Team

  1. After logging in, visit the Teams page
  2. Click the "Create Team" button
  3. Enter a team name
  4. Click "Create Team" to complete

Team Roles

SteamData Connect provides three team roles:

RolePermissions
OwnerFull control over the team, can delete team, transfer ownership, manage all settings
AdminCan manage team members, create invitations, configure API keys
MemberCan view team information and data, but cannot perform management operations

Inviting Members

There are two ways to invite members to join a team:

Method 1: Email Invitation

  1. Go to the team page
  2. Click the "Invitations" tab
  3. Click "Create Invitation"
  4. Select "Email Invitation"
  5. Enter the invitee's email address
  6. Select role (Admin or Member)
  7. Set expiration period
  8. Click "Create Invitation"

Email invitations are limited to specified email addresses and are more secure.

Method 2: Link Invitation

  1. Go to the team page
  2. Click the "Invitations" tab
  3. Click "Create Invitation"
  4. Select "Link Invitation"
  5. Select role (Admin or Member)
  6. Set expiration period
  7. Click "Create Invitation"
  8. Copy the generated link and share

Link invitations can be used by anyone and are suitable for quick sharing.

Managing Members

Change Member Role

  1. Go to the team page
  2. Click the "Members" tab
  3. Click on the member to manage
  4. Select new role on member details page
  5. Click "Update Role"

Remove Member

  1. Go to the team page
  2. Click the "Members" tab
  3. Click on the member to remove
  4. Click "Remove Member"
  5. Confirm the operation

Note: Removing a member cannot be undone.

Transfer Ownership

Only the owner can transfer ownership:

  1. Go to the team page
  2. Click the "Members" tab
  3. Click on the member to transfer to
  4. Click "Transfer Ownership"
  5. Confirm the operation

Warning: After transfer, you'll become an admin and cannot transfer or delete the team anymore.

API Key Management

Connect API Keys

Connect API keys are used to call SteamData Connect's public APIs.

Creating a Key

  1. Go to the team page
  2. Click the "Connect API" tab
  3. Click "Create Key"
  4. Enter key name (e.g., "Production", "Testing")
  5. Click "Create Key"
  6. Immediately copy and save the key (shown only once)

Managing Keys

You can perform the following operations on keys:

  • Enable/Disable - Temporarily disable key without deleting
  • Regenerate - Generate new key (old key becomes immediately invalid)
  • Delete - Permanently delete key

View Quota

On the Connect API page, you can view:

  • Current quota usage
  • Total quota
  • Quota reset time

Steam Financial API Keys

Steam Financial API keys are used to fetch your game sales data.

Adding Steam Keys

  1. Go to the team page
  2. Click the "Steam Keys" tab
  3. Click "Add Key"
  4. Enter key name
  5. Paste your Financial API Key from Steamworks
  6. Click "Add"

Tip: How to get Steam Financial API Key? Visit Steamworks Partner Dashboard to apply.

Managing Steam Keys

You can:

  • Enable/Disable - Control whether to use this key for data fetching
  • Delete - Remove key configuration

Team Settings

Basic Information

On the team settings page, you can:

  • Modify team name
  • View team ID (used for API calls)
  • View creation time

Delete Team

Dangerous Operation: Deleting a team permanently deletes all related data and cannot be recovered.

Only the owner can delete a team:

  1. Go to team settings page
  2. Scroll to "Danger Zone"
  3. Click "Delete Team"
  4. Confirm the operation

Data Analytics (Coming Soon)

Data analytics features are under development. Coming soon:

  • Revenue Analysis - View game revenue trends and details
  • Sales Statistics - Analyze sales data and growth trends
  • Regional Analysis - Understand performance in different regions
  • Platform Comparison - Compare data across platforms
  • User Behavior - Analyze user behavior and retention data

After configuring Steam Financial API keys, you'll be able to use these features.

Personal Settings

Profile

On the personal settings page, you can:

  • Modify username
  • View email address
  • View user ID
  • View registration time

Identity Bindings

Manage your third-party account bindings:

  • View bound accounts (GitHub, Google, etc.)
  • Unbind accounts (must keep at least one)

Note: You must keep at least one identity binding to continue logging in.

Delete Account

Dangerous Operation: Deleting your account permanently deletes all your data and cannot be recovered.

Deleting your account will:

  • Permanently delete your account information
  • Delete all teams you created
  • Remove your membership from all teams
  • Delete all related data

Best Practices

Security Recommendations

  1. Protect API Keys - Don't hardcode keys in code repositories
  2. Use Environment Variables - Manage keys through environment variables
  3. Regular Key Rotation - Regularly regenerate keys for better security
  4. Principle of Least Privilege - Give team members appropriate role permissions
  5. Monitor Quota Usage - Regularly check API quota usage

Team Collaboration Recommendations

  1. Clear Role Division - Assign appropriate roles based on responsibilities
  2. Use Email Invitations - More secure when inviting specific members
  3. Remove Former Members Promptly - Keep team member list accurate
  4. Backup Important Keys - Securely back up API keys to a password manager

FAQ

How do I recover a lost API key?

API keys are shown only once after creation and cannot be recovered. If lost, please regenerate a new key.

How many teams can I create?

There's currently no limit on the number of teams you can create.

Is there a limit on team members?

Team member limits vary by plan:

  • Free Tier: Up to 5 members
  • Standard Tier: Up to 20 members
  • Enterprise Tier: Unlimited

How do I upgrade my plan?

Plan features are under development. Stay tuned.

Get Help

If you encounter issues using the Dashboard:

Happy using! Feel free to contact us anytime with suggestions or feedback.