elmo
Sign up

Get a brand

GET
/brands/{brandId}

Authorization

BearerAuth
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Path Parameters

brandId*string

Brand identifier

Length1 <= length

Response Body

Brand

application/json
  1. response
id*string

User-supplied brand identifier (e.g. "acme")

name*string
domains*array<string>

Brand domains. The first entry is the primary website; remaining entries are additional domains.

aliases*array<string>
enabled*boolean
onboarded*boolean
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
organizationId*string

The organization that owns this brand and is billed for it.

enabledModels*array<string>|

Models this brand is tracked on. Null means the deployment default.

delayOverrideHours*|

Sampling cadence override in hours. Null means the plan cadence.

Example Request
curl -X GET 'https://app.elmohq.com/api/v1/brands/string'
Example Response
{
  "id": "string",
  "name": "string",
  "domains": [
    "string"
  ],
  "aliases": [
    "string"
  ],
  "enabled": true,
  "onboarded": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "organizationId": "string",
  "enabledModels": [
    "string"
  ],
  "delayOverrideHours": 0
}