# Unbounce API
An [Unbounce API](https://developer.unbounce.com/api_reference/) 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](https://developer.unbounce.com/getting_started/). Find the project on the Python Package Index website here: [unbounce-python-api](https://pypi.org/project/unbounce-python-api/).
To get started, install the package:
```console
user@machine:~/$ pip install unbounce-python-api
```
Then, import it into your project:
```python
from unbounceapi.client import Unbounce
ub = Unbounce('YOUR_API_KEY')
```
## Global API
Read the docs here: [Global API](https://developer.unbounce.com/api_reference/).
**Available Methods**
- `ub.get_global()`
## Accounts
Read the docs here: [Accounts API](https://developer.unbounce.com/api_reference/#id_accounts).
**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](https://developer.unbounce.com/api_reference/#id_sub_accounts__sub_account_id_).
**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](https://developer.unbounce.com/api_reference/#id_domains__domain_id_).
**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](https://developer.unbounce.com/api_reference/#id_pages).
**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](https://developer.unbounce.com/api_reference/#id_page_groups__page_group_id__pages).
**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](https://developer.unbounce.com/api_reference/#id_leads__lead_id_).
**Available Methods**
- `ub.leads.get_lead(lead_id)`
- lead_id (required)
## Users
Read the docs here: [Users API](https://developer.unbounce.com/api_reference/#id_users).
- `ub.users.get_user(user_id=None)`
- user_id (optional)
## Contact
For support, feedback or, to report a bug, you may contact the maintainer:
- Yoshio Hasegawa: [GitHub](https://github.com/yoshiohasegawa), [LinkedIn](https://www.linkedin.com/in/yoshiohasegawa/)
### License
Distributed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/yoshiohasegawa/unbounce-python-api",
"name": "unbounce-python-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Unbounce,API,Wrapper",
"author": "Yoshio Hasegawa",
"author_email": "yoshio.seisuke.hasegawa@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/05/e2/494617e84a84b7613b8c30a726565ade732a7d42f2e0eec5628a8716b3fd/unbounce-python-api-1.3.5.tar.gz",
"platform": null,
"description": "# Unbounce API\nAn [Unbounce API](https://developer.unbounce.com/api_reference/) wrapper written in Python.\n\n## Getting Started\nFind more information on authorization, managing API keys, using OAuth, permissions, rate limits, errors, and more on the [Unbounce API webpage](https://developer.unbounce.com/getting_started/). Find the project on the Python Package Index website here: [unbounce-python-api](https://pypi.org/project/unbounce-python-api/).\n\nTo get started, install the package:\n```console\nuser@machine:~/$ pip install unbounce-python-api\n```\n\nThen, import it into your project:\n```python\nfrom unbounceapi.client import Unbounce\nub = Unbounce('YOUR_API_KEY')\n```\n\n## Global API\nRead the docs here: [Global API](https://developer.unbounce.com/api_reference/).\n\n**Available Methods**\n\n- `ub.get_global()`\n\n## Accounts\nRead the docs here: [Accounts API](https://developer.unbounce.com/api_reference/#id_accounts).\n\n**Available Methods**\n\n- `ub.accounts.get_accounts(account_id=None, **kwargs)`\n - account_id (optional)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n\n- `ub.accounts.get_sub_accounts(account_id, **kwargs)`\n - accounts_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n- `ub.accounts.get_account_pages(account_id, **kwargs)`\n - account_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n## Sub Accounts\nRead the docs here: [Sub Accounts API](https://developer.unbounce.com/api_reference/#id_sub_accounts__sub_account_id_).\n\n**Available Methods**\n\n- `ub.sub_accounts.get_sub_account(sub_account_id)`\n - sub_account_id (required)\n\n- `ub.sub_accounts.get_sub_account_domains(sub_account_id, **kwargs)`\n - sub_account_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or ' desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n- `ub.sub_accounts.get_sub_account_page_groups(sub_account_id, **kwargs)`\n - sub_account_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n- `ub.sub_accounts.get_sub_accounts_pages(sub_account_id, **kwargs)`\n - sub_account_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n## Domains\nRead the docs here: [Domains API](https://developer.unbounce.com/api_reference/#id_domains__domain_id_).\n\n**Available Methods**\n\n- `ub.domains.get_domain(domain_id)`\n - domain_id (required)\n\n- `ub.domains.get_domain_pages(domain_id, kwargs**)`\n - domain_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n## Pages\nRead the docs here: [Pages API](https://developer.unbounce.com/api_reference/#id_pages).\n\n**Available Methods**\n\n- `ub.pages.get_pages(page_id=None, **kwargs)`\n - page_id (optional)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n - with_stats (optional) [Default: 'False', Options: 'True' or 'False']\n - role (optional) [Default: 'author', Options: 'author' or 'viewer']\n\n- `ub.pages.get_form_fields(page_id, **kwargs)`\n - page_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - include_sub_pages [Default: 'False', Options: 'True' or 'False']\n\n- `ub.pages.get_page_leads(page_id, lead_id=None, **kwargs)`\n - page_id (required)\n - lead_id (optional)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', ex: '10']\n\n- `ub.pages.create_page_lead(page_id)`\n - page_id (required)\n\n- `ub.pages.delete_page_lead(page_id, lead_id)`\n - page_id (required)\n - lead_id (required)\n\n- `ub.pages.post_lead_deletion_request(page_id)`\n - page_id (required)\n\n- `ub.pages.get_lead_deletion_request_status(page_id, lead_deletion_request_id)`\n - page_id (required)\n - lead_deletion_request_id (required)\n\n## Page Groups\nRead the docs here: [Page Groups API](https://developer.unbounce.com/api_reference/#id_page_groups__page_group_id__pages).\n\n**Available Methods**\n\n- `ub.page_groups.get_page_group_pages(page_group_id, **kwargs)`\n - page_group_id (required)\n - sort_order (optional) [Default: 'asc', Options: 'asc' or 'desc']\n - count (optional) [Default: 'False', Options: 'True' or 'False']\n - _from (optional) [ex: '2018-01-01T00:00:00.000Z']\n - to (optional) [ex: '2018-12-31T00:00:00.000Z']\n - offset (optional) [ex: '3']\n - limit (optional) [Default: '50', Max: '1000', Ex: '10']\n\n## Leads\nRead the docs here: [Leads API](https://developer.unbounce.com/api_reference/#id_leads__lead_id_).\n\n**Available Methods**\n\n- `ub.leads.get_lead(lead_id)`\n - lead_id (required)\n\n## Users\nRead the docs here: [Users API](https://developer.unbounce.com/api_reference/#id_users).\n\n- `ub.users.get_user(user_id=None)`\n - user_id (optional)\n\n\n## Contact\nFor support, feedback or, to report a bug, you may contact the maintainer:\n- Yoshio Hasegawa: [GitHub](https://github.com/yoshiohasegawa), [LinkedIn](https://www.linkedin.com/in/yoshiohasegawa/)\n\n### License\nDistributed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An Unbounce API wrapper written in python.",
"version": "1.3.5",
"project_urls": {
"Download": "https://github.com/yoshiohasegawa/unbounce-python-api/archive/refs/tags/v1.3.5.tar.gz",
"Homepage": "https://github.com/yoshiohasegawa/unbounce-python-api"
},
"split_keywords": [
"unbounce",
"api",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "568103d70772a1fd108b70c4d76c7e627f60b125f327080cf568f18a50723a4a",
"md5": "8893d15c1c6c3bbe1cc8d8bc12c0c5a9",
"sha256": "1af8d318c316b53e8da083a4442a4f81ffc2a3ff9a920b1a5666c0b0d5b8445e"
},
"downloads": -1,
"filename": "unbounce_python_api-1.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8893d15c1c6c3bbe1cc8d8bc12c0c5a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19517,
"upload_time": "2023-05-23T03:16:07",
"upload_time_iso_8601": "2023-05-23T03:16:07.773998Z",
"url": "https://files.pythonhosted.org/packages/56/81/03d70772a1fd108b70c4d76c7e627f60b125f327080cf568f18a50723a4a/unbounce_python_api-1.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05e2494617e84a84b7613b8c30a726565ade732a7d42f2e0eec5628a8716b3fd",
"md5": "31319b02efddb623ec8a5aff8a50be99",
"sha256": "4c819a7086598814d7a93087a78e0f5411585c0e1395f81fa190752693b9f4c7"
},
"downloads": -1,
"filename": "unbounce-python-api-1.3.5.tar.gz",
"has_sig": false,
"md5_digest": "31319b02efddb623ec8a5aff8a50be99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10811,
"upload_time": "2023-05-23T03:16:09",
"upload_time_iso_8601": "2023-05-23T03:16:09.885575Z",
"url": "https://files.pythonhosted.org/packages/05/e2/494617e84a84b7613b8c30a726565ade732a7d42f2e0eec5628a8716b3fd/unbounce-python-api-1.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-23 03:16:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yoshiohasegawa",
"github_project": "unbounce-python-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "unbounce-python-api"
}
JSON
