DocsTools
Convert.com
A/B test results and revenue per visitor.
- Category
- Analytics
- How you connect
- API key or token. You paste a key or token from the tool. Homla stores it encrypted and never shows it again.
- Time to set up
- About 4 minutes
- Actions
- 9 read, 9 write
Connect it#
In Homla, open Connectors, then Convert.com. The Setup guide button walks you through the same steps, with fields to paste into.
Who can do it. An owner, account manager or admin of the Convert account creates a key that can see every project. A user who only has access to some projects can still create a key, limited to those projects. A key can never do more than the person who created it.
Recommended. Invite a dedicated collaborator such as [email protected] from the account's Collaborators page, with access to the projects Homla should work on, sign in as it, and create the key there. Every change Homla makes then shows under that name in the change history, and you can cut it off without touching anyone's access. Depending on your Convert plan, a collaborator can count against your user limit.
- Sign in and note your account IDSign in to Convert, ideally as the dedicated wedge-bot collaborator. The address bar then reads app.convert.com/accounts/<number>/…: that number is the account ID. Type it in the box above so the next links open the right page. Open it.
- Optional: invite a dedicated wedge-bot collaboratorOn the Collaborators page, invite [email protected] with access to the projects Homla should see and the role you pick in the next step. Accept the invitation from that mailbox, then sign in as it for the rest of this guide. Skip this step to create the key from your own account.
- Open the API Keys page of the accountThis page lists the account's API keys and is where a new one is created.
- Create the key: Secret Key auth, your projects, the smallest roleAdd a new key named Homla. Set the authentication type to Secret Key: Homla sends the key as a Bearer token, and a key left on Request Signing (the default) is refused with a 401. Limit it to the projects Homla should see instead of the whole account. Pick the role from the permissions list below: browse for results only, edit to build and configure tests, publish to also launch, pause and complete them, admin to also exclude IPs from reports.
Read-only company? Pick browse. Every read tool works; the write tools then return Convert's permission error.
- Copy the Key ID and the Key SecretOnce created, Convert shows the key's ID and its secret. Copy both.
The secret is shown only once. Paste it straight into Homla; if you lose it, delete the key and create a new one.
- Paste both values into HomlaIn Homla, open Connectors, then Convert.com, then Connect an account. Name the account after the client, paste the key ID into Convert API Key ID and the secret into Convert API Key Secret, and save. Homla encrypts them and never shows them again. Then ask your assistant to list your Convert accounts to check the key works. Open it.
What your AI can do#
These are the actions Homla gives your AI. Your role decides which ones you get. Write actions are a dry run until confirmed, see Approvals and dry runs.
Read#
Looks things up, never changes anything.
| Action | What it does |
|---|---|
convert_accounts_list | The Convert accounts this key can see. |
convert_projects_list | The projects (websites) in an account. |
convert_experiences_list | The experiments in a project, with status. |
convert_experience_get | One experiment in full: status, thresholds, goal, each arm's redirect, and location rules. |
convert_project_get | A project's reporting settings: the thresholds a new experiment inherits, and the IPs excluded from reports. |
convert_goals_list | The goals in a project, with id and type. |
convert_locations_list | Every location (URL targeting rule) in a project, with its rules and a warning on any rule too narrow for its traffic. |
convert_url_conflicts | Which live experiments already target a URL. |
convert_experience_report | Results for one experiment, one row per arm: visitors, conversions, CVR, revenue, RPV, AOV, significance. |
Write#
Creates or changes things, as the account owner.
| Action | What it does |
|---|---|
convert_project_blocked_ips_set | Exclude an IP from every report in the project. |
convert_goal_create | Create a goal. |
convert_experience_status_set | Start, pause or stop an experiment. |
convert_experience_settings_set | Set an experiment's stopping thresholds. |
convert_experience_goal_set | Point an experiment at the goal and metric it is decided on. |
convert_experience_traffic_set | Set per-variation traffic split (control 80%, variants 10%+10%). |
convert_experience_rename | Rename an experiment and/or one or more of its variations. |
convert_location_set | Create or repair a location's URL rule. |
convert_split_create | Create a split-URL experiment in DRAFT: each arm's redirect, and a location for the control page. |
Disconnect it#
In Homla, open the account menu on the tool's page and choose Disconnect. Anyone it was shared with loses access at once. To cut it off on the tool's side too:
To cut Homla off, delete the Homla key on the account's API Keys page: every call stops at once. If you used a wedge-bot collaborator, removing it from Collaborators also works. To rotate, create a new key the same way, paste its ID and secret into the same Homla form, then delete the old key.
Generated from the product code. Action names are what the CLI and the API use.