Unbounce API
An Unbounce API wrapper written in Python.
Getting Started
Find more information on authorization, managing API keys, using OAuth, permissions, rate limits, errors, and more on the Unbounce API webpage. Find the project on the Python Package Index website here: unbounce-python-api.
To get started, install the package:
user@machine:~/$ pip install unbounce-python-api
Then, import it into your project:
from unbounceapi.client import Unbounce
ub = Unbounce('YOUR_API_KEY')
Global API
Read the docs here: Global API.
Available Methods
ub.get_global()
Accounts
Read the docs here: Accounts API.
Available Methods
-
ub.accounts.get_accounts(account_id=None, **kwargs)- account_id (optional)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
-
ub.accounts.get_sub_accounts(account_id, **kwargs)- accounts_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
-
ub.accounts.get_account_pages(account_id, **kwargs)- account_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
Sub Accounts
Read the docs here: Sub Accounts API.
Available Methods
-
ub.sub_accounts.get_sub_account(sub_account_id)- sub_account_id (required)
-
ub.sub_accounts.get_sub_account_domains(sub_account_id, **kwargs)- sub_account_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or ' desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
-
ub.sub_accounts.get_sub_account_page_groups(sub_account_id, **kwargs)- sub_account_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
-
ub.sub_accounts.get_sub_accounts_pages(sub_account_id, **kwargs)- sub_account_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
Domains
Read the docs here: Domains API.
Available Methods
-
ub.domains.get_domain(domain_id)- domain_id (required)
-
ub.domains.get_domain_pages(domain_id, kwargs**)- domain_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
Pages
Read the docs here: Pages API.
Available Methods
-
ub.pages.get_pages(page_id=None, **kwargs)- page_id (optional)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
- with_stats (optional) [Default: 'False', Options: 'True' or 'False']
- role (optional) [Default: 'author', Options: 'author' or 'viewer']
-
ub.pages.get_form_fields(page_id, **kwargs)- page_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- include_sub_pages [Default: 'False', Options: 'True' or 'False']
-
ub.pages.get_page_leads(page_id, lead_id=None, **kwargs)- page_id (required)
- lead_id (optional)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', ex: '10']
-
ub.pages.create_page_lead(page_id)- page_id (required)
-
ub.pages.delete_page_lead(page_id, lead_id)- page_id (required)
- lead_id (required)
-
ub.pages.post_lead_deletion_request(page_id)- page_id (required)
-
ub.pages.get_lead_deletion_request_status(page_id, lead_deletion_request_id)- page_id (required)
- lead_deletion_request_id (required)
Page Groups
Read the docs here: Page Groups API.
Available Methods
ub.page_groups.get_page_group_pages(page_group_id, **kwargs)- page_group_id (required)
- sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']
- count (optional) [Default: 'False', Options: 'True' or 'False']
- _from (optional) [ex: '2018-01-01T00:00:00.000Z']
- to (optional) [ex: '2018-12-31T00:00:00.000Z']
- offset (optional) [ex: '3']
- limit (optional) [Default: '50', Max: '1000', Ex: '10']
Leads
Read the docs here: Leads API.
Available Methods
ub.leads.get_lead(lead_id)- lead_id (required)
Users
Read the docs here: Users API.
ub.users.get_user(user_id=None)- user_id (optional)
Contact
For support, feedback or, to report a bug, you may contact the maintainer:
License
Distributed under the MIT License.
Metadata
Release files for unbounce-python-api 1.3.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| unbounce-python-api-1.3.5.tar.gz | 10.8 kB | Without provenance | Details for unbounce-python-api-1.3.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| unbounce_python_api-1.3.5-py3-none-any.whl | Python 3 | none | any | Details for unbounce_python_api-1.3.5-py3-none-any.whl |
Total release size: 30.3 kB
Release files / unbounce-python-api-1.3.5.tar.gz
| Download URL | unbounce-python-api-1.3.5.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c819a7086598814d7a93087a78e0f5411585c0e1395f81fa190752693b9f4c7
|
|
BLAKE2b-256 checksum How to use checksums |
05e2494617e84a84b7613b8c30a726565ade732a7d42f2e0eec5628a8716b3fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.14
|
Release files / unbounce_python_api-1.3.5-py3-none-any.whl
| Download URL | unbounce_python_api-1.3.5-py3-none-any.whl |
|---|---|
| Size | 19.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1af8d318c316b53e8da083a4442a4f81ffc2a3ff9a920b1a5666c0b0d5b8445e
|
|
BLAKE2b-256 checksum How to use checksums |
568103d70772a1fd108b70c4d76c7e627f60b125f327080cf568f18a50723a4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.14
|
Security for unbounce-python-api 1.3.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.