Glossary and helper

Models definition and architecture

CAMPAIGN (Use Case)

You can create campaigns of different types (ab, toggle, perso) and adding options to it thanks to the Remote Control API :

• Configure goals

• Configure flags

• Configure targeting

You can find the payload architecture of campaigns here.

PROJECT

Campaigns are linked to a project, you can manage them thanks to the Remote Control API. You can find the payload architecture of project here .

TARGETING KEY

You can find the payload architecture of targeting key here.

FLAG

You can find the payload architecture of flag here.

GOAL (KPI)

You can find the payload architecture of goals here.

Platform concepts

CLIENT_ID

API parameter (body). You can find your client_id when you generate an access). Save it on your side then, it will not be accessible on the platform anymore.

CLIENT_SECRET

API parameter (body). You can find your client_secret when you generate an access). Save it on your side then, it will not be accessible on the platform anymore.

ACCOUNT_ID

API parameter (query). ID of your account. You can find your account_id in the Settings > Account section.

API helpers

Pagination

For listing routes, you can paginate your results. To do that use the _page url parameter. If you want to specify the max number of items per page, you can use the _max_per_page url parameter.

?_page=1&_max_per_page=5