Skip to main content

​
Get Brand Details

Retrieve details about a specific project (brand).
​
brand
string
required
The brand/project ID
Request
GET /api/brands/{brand}
cURL
curl https://app.elasticfunnels.io/api/brands/{brand_id} \
  -H "EF-Access-Key: your_api_key_here"

{
  "id": 123,
  "name": "My Awesome Funnel",
  "subdomain": "myawesomefunnel",
  "timezone": "America/New_York",
  "currency": "USD",
  "subscription_status": "active",
  "created_at": "2024-01-15T10:30:00.000000Z",
  "updated_at": "2024-12-10T08:20:00.000000Z"
}

​
List All Brands

Get a list of all projects you have access to.
Request
GET /api/brands/all
cURL
curl https://app.elasticfunnels.io/api/brands/all \
  -H "EF-Access-Key: your_api_key_here"

{
  "data": [
    {
      "id": 123,
      "name": "My Awesome Funnel",
      "subdomain": "myawesomefunnel",
      "subscription_status": "active"
    },
    {
      "id": 456,
      "name": "Another Project",
      "subdomain": "anotherproject",
      "subscription_status": "active"
    }
  ]
}

​
Update Brand

Update project settings (requires admin/owner permissions).
​
brand
string
required
The brand/project ID
​
name
string
Project name
​
timezone
string
Project timezone (e.g., “America/New_York”)
​
currency
string
Currency code (e.g., “USD”, “EUR”)
Request
PUT /api/brands/{brand}
cURL
curl -X PUT https://app.elasticfunnels.io/api/brands/{brand_id} \
  -H "EF-Access-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Project Name",
    "timezone": "America/Los_Angeles"
  }'

{
  "id": 123,
  "name": "Updated Project Name",
  "subdomain": "myawesomefunnel",
  "timezone": "America/Los_Angeles",
  "currency": "USD",
  "subscription_status": "active",
  "updated_at": "2024-12-10T15:45:00.000000Z"
}

​
Get Brand Metrics

Retrieve configured metrics for the project.
​
brand
string
required
The brand/project ID
Request
GET /api/brands/{brand}/metrics
cURL
curl https://app.elasticfunnels.io/api/brands/{brand_id}/metrics \
  -H "EF-Access-Key: your_api_key_here"

{
  "metrics": [
    "orders",
    "revenue",
    "aov",
    "conversion_rate",
    "roas"
  ]
}