Skip to main content

​
Overview

Consuelo can serve as your internal growth operating system, tracking metrics, automating workflows, and powering analytics. This guide covers setting up a dedicated internal workspace.

​
Accessing the Internal Instance

Consuelo maintains an internal workspace for team operations:
  • URL: https://<your-internal-domain>
  • GraphQL Endpoint: https://<your-internal-domain>/graphql
  • Metadata Endpoint: https://<your-internal-domain>/metadata
Internal workspace access requires appropriate permissions. Contact your administrator if you need access.

​
Workspace Setup Checklist

​
1. Create API Key

Generate a dedicated API key for internal operations:
  1. Navigate to Settings → APIs & Webhooks
  2. Click + Create key
  3. Configure:
    • Name: “Internal Growth Operations”
    • Expiration: Set based on your security policy
  4. Copy and store securely - the key is shown only once

​
2. Assign Role

For security, assign a specific role to your API key:
  1. Go to Settings → Roles
  2. Select or create a role for internal operations
  3. Under Assignment tab, click + Assign to API key
  4. Select your internal operations key

​
3. Test Connection

Verify your setup with a simple query: 
query TestConnection {
  currentUser {
    id
    email
  }
}
Expected response: 
{
  "data": {
    "currentUser": {
      "id": "...",
      "email": "your-email@consuelohq.com"
    }
  }
}
For internal growth operations, we recommend creating these custom objects:

​
Growth Metrics

Track key performance indicators:
  • Signup conversion rates
  • Activation milestones
  • Feature adoption
  • Revenue metrics

​
Cohorts

Group users by signup date for cohort analysis:
  • Weekly cohorts
  • Monthly cohorts
  • Channel-based cohorts

​
Experiments

Track A/B tests and experiments:
  • Test variants
  • Participant counts
  • Conversion rates
  • Statistical significance

​
Environment Variables

For scripts and automation, store these securely: 
CONSUELO_API_KEY=your_api_key_here
CONSUELO_WORKSPACE_ID=7d0894c1-bdb1-4dd6-9a00-78681b52d5f6
CONSUELO_GRAPHQL_URL=https://consuelo.consuelohq.com/graphql

​
Security Best Practices

  • Rotate API keys every 90 days
  • Use environment variables - never hardcode keys
  • Assign minimal permissions via roles
  • Monitor usage in Settings → APIs & Webhooks
  • Revoke unused keys immediately

​
Next Steps