https://github.com/dynata/msight-csl
Python client-side library for MarketSight API.
https://github.com/dynata/msight-csl
Last synced: 4 months ago
JSON representation
Python client-side library for MarketSight API.
- Host: GitHub
- URL: https://github.com/dynata/msight-csl
- Owner: dynata
- License: mit
- Created: 2021-06-16T06:57:22.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-06-13T02:01:41.000Z (almost 4 years ago)
- Last Synced: 2025-09-08T05:58:35.777Z (9 months ago)
- Language: Python
- Homepage:
- Size: 1.01 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
####################################################
Dynata Reporting & Analytics API
####################################################
.. image:: https://marketsight.readthedocs.io/en/latest/_static/marketsight-logo.png
:alt: Dynata Reporting & Analytics
:align: right
:width: 120
:height: 120
:target: https://marketsight.readthedocs.io/en/latest.html
**Python bindings for the Dynata Reporting & Analytics (MarketSight) API**
The **MarketSight Client API** library provides Python bindings for the
Dynata Reporting & Analytics API, providing a Pythonic interface for
interacting with the underlying platform's RESTful APIs.
.. contents::
:depth: 3
:backlinks: entry
------------------------
*****************
Installation
*****************
To install **MarketSight API Client**, just execute:
.. code:: bash
$ pip install marketsight
Dependencies
=================
* `Validator-Collection v.1.5.0 `_ or higher
* `simplejson v.3.0 `_ or higher
* `bravado v.10.6.0 `_ or higher
* `dpath v.2.0.1 `_ or higher
-----------------------------------
*********************************
Key MarketSight API Features
*********************************
* Ability to manage your Account settings within the Dynata Reporting
& Analytics platform.
* Ability to manage data within the Dynata Reporting & Analytics platform.
* Ability to perform high-end statistical analyses on your data in the
Dynata Reporting & Analytics platform.
* Ability to produce interactive visualizations of your data and insights.
* Ability to produce and share interactive dashboards to deliver your insights
to downstream users.
* Ability to embed or otherwise integrate the MarketSight platform into your
applications.
-----------------------
**********************************
Hello, World and Basic Usage
**********************************
1. Initialize the Library
==========================================
.. code-block:: bash
# Import the MarketSight API Client
import marketsight
# Call the "client" factory function.
api = marketsight.client("https://application.marketsight.com/api/v1/swagger/public.json")
2. Authorize Against the API
================================
.. code-block:: bash
# Initialize the MarketSight API Client.
api = marketsight.client("https://application.marketsight.com/api/v1/swagger/public.json")
# Connect your instance to the API and authorize as a partner.
api.connect(
client_id = "MY CLIENT ID GOES HERE",
client_secret = "MY CLIENT SECRET GOES HERE"
)
3. Call the API
=====================
Execute API calls to perform operations, for example:
.. code-block:: bash
# Retrieve an Account
account = api.Accounts.retrieve(account_id = "MY ACCOUNT ID GOES HERE")
# Retrieve a User
user = api.Users.retrieve(user_id = "MY USER ID GOES HERE")
# Retrieve a Dataset's Meta-data
dataset = api.Datasets.retrieve(dataset_id = "MY DATASET ID GOES HERE")
---------------
*********************
Questions and Issues
*********************
You can ask questions and report issues on the project's
`Github Issues Page `_
--------------------
**********************
License
**********************
**MarketSight Core** is made available under an
`MIT License `_.