Alpina
Alpina
Alpina
Alpina
Introduction
Open dashboard
General
Integration
Customer data policy
Accepted currencies
FAQ
How to use
Rollouts
Changelog
Captcha
Web Analytics & Events
SPA support
Trigger pageviews
What we collect & why
Event Tracking
API
Getting started
Authentication
Web Analytics endpoints
Captcha endpoints
Rollouts endpoints
Powered by GitBook

Rollouts endpoints

get
List features

https://alpina.cloud/api/v1/client/rollouts/{PROFILE_ID}/features
Returns a list of all rollouts features owned by the given profile.
Request
Response
Request
Path Parameters
PROFILE_ID
required
string
UUID of profile
Headers
x-api-key
required
string
API key with ROLLOUTS_SCOPE
x-api-secret
required
string
API secret with ROLLOUTS_SCOPE
Response
200: OK
{
    "data": [{
        "allocation": 50,
        "author": {
            "avatar": "",
            "email": "[email protected]",
            "name": "Author Name",
            "uuid": "afad5fff-f372-45a1-b682-8f7f6544f059"
        },
        "createdAt": "2019-01-01T18:28:23.713Z",
        "featureId": "test",
        "killSwitch": false,
        "name": "test",
        "uuid": "16a1fae6-7300-4412-abea-3d7f5a367725"
    }]
}

get
Get specific feature

https://alpina.cloud/api/v1/client/rollouts/{PROFILE_ID}/features/{FEATURE_ID}
Similar output to the list features endpoint, except this endpoint returns an additional stats object
Request
Response
Request
Path Parameters
PROFILE_ID
required
string
UUID of profile that owns the rollouts feature
FEATURE_ID
required
string
UUID of specific rollouts feature
Headers
x-api-key
required
string
API key with ROLLOUTS_SCOPE
x-api-secret
required
string
API secret with ROLLOUTS_SCOPE
Response
200: OK
{
    "data": {
        "allocation": 50,
        "author": {
            "avatar": "",
            "email": "[email protected]",
            "name": "Author Name",
            "uuid": "afad5fff-f372-45a1-b682-8f7f6544f059"
        },
        "createdAt": "2019-01-01T18:28:23.713Z",
        "featureId": "test",
        "killSwitch": false,
        "name": "test",
        "stats": {
            "activeUserCount": 10,
            "inactiveUserCount": 11,
            "totalChecks": 21,
            "totalPositives": 10
        },
        "uuid": "16a1fae6-7300-4412-abea-3d7f5a367725"
    }
}

patch
Update feature settings

https://alpina.cloud/api/v1/client/rollouts/{PROFILE_ID}/features/{FEATURE_ID}
Request
Response
Request
Path Parameters
PROFILE_ID
required
string
UUID of profile that owns the rollouts feature
FEATURE_ID
required
string
UUID of specific rollouts feature
Headers
x-api-key
required
string
API key with ROLLOUTS_SCOPE
x-api-secret
required
string
API secret with ROLLOUTS_SCOPE
Body Parameters
allocation
required
number
Allocation of active users
killSwitchState
required
boolean
if set to true the feature will be temporarily disabled for all users (including previously active users)
Response
200: OK
​

​

API - Previous
Captcha endpoints
Last updated 9 months ago
Contents
get
List features
get
Get specific feature
patch
Update feature settings