Getting Remote Configs via REST API
Joystick manages all of your remote configs in one powerful platform, and allows you to retrieve it easily over REST API at scale.
You will need to create an API Key to retrieve content via API.
Request and Response
This is the request and response for getting a single piece of content via REST API. You can get also get multiple pieces of content with a single call.
Replace the :contentId indicated with the Configuration Content Id you created. :contentId is not case sensitive.
||Your API Key||Yes||The API key created for the environment you are targeting. This is different for each environment.|
Request Query Parameters
||Optional||Case sensitive. Indicates to serialize the 'data' object on the response. See the response section for the output.
The request body should be JSON, and cannot be empty. It must at minimum consist of the following snippet.
||String. Required.||This is the unique identifier for a particular user. We use this identifier to split users into sticky AB Test groups. Send an empty string at minimum.|
||Object. Required.||This is a dictionary of key:value attributes that can be used by Joystick for segmentation (different config content can be returned based on the attributes you send). Send an empty object at minimum. View Usage Details|
||String. Optional.||This is the semantic version of your app that is making the request. We highly recommend sending this as we are able to deliver backward compatible revisions of configuration based on semantic versioning. This must be a three-part semantic version as string e.g. "3.2.1"|
Having issues? View our troubleshooting guide.
||This is your configuration content returned as well formatted JSON with a) all in-line comments stripped out and b) any dynamic content replaced based on segmentation or ab-testing. This can optionally be returned as a serialized string.|
||This is a hash of the content. You can use this to determine if the content has been updated since your last request. The hash only changes if the content has changed. For example, if on a request you get the same hash, you may not need to updated the cached version of the configuration content in your app.|
||Joystick we take the put the
||The last three digits of the
||This is an array of objects that will tell you the segment name and ab test group variant name that mutated the data in this request. If it is empty, it means the response is default values, and not in any AB test or segmentation. Learn more about this in Dynamic Content.|
Understanding the "meta.seg" component
The meta.seg component of the response is important for Business Intelligence or Analytics. It will tell you the segment name, variant name and an optional small snippet of additional information you can pass.
|seg object part||Description|
||Name of the segment that the response was included in.|
||Variant Name. If you are running an AB Test using Joystick, this will the name or label of the variant that the response was included in.|
||This is optional information you can to send to tag or identify a particular variant. This can be configured on the Dynamic Mapping.|
We highly recommend there is a fallback in your app to gracefully handle the case if Joystick cannot be reached. Please refer to our Integration Guide for more information!
You can get multiple configs back with one call. Please refer to our Multiple Content API!
Get a Sandbox Account
Equip your team with rocket boosters. Get a sandbox account today .