Skip to main content

A tiny package for cXense API

Project description

A Tiny package for cXense API

Make cXense API simple.

Requirements

Python 3.6 above  (did't test in other versions)

Installation

pip install pyCx

How to use

Step 1: create a Cx object with env.yaml by using CxConfig

import os
from pyCx import Cx, CxConfig

# using env.yaml
fp = os.path.abspath('env.yaml')
cx = Cx(CxConfig(fp))

# or just passing dict value
my_cx_config = {
    'site_id': YOUR_ID,
    'username': 'YOUR_USERNAME',
    'secret': 'YOUR_KEY',
    'apiserver': 'https://api.cxense.com',
}
cx = Cx(my_cx_config)

and here's env.yaml sample:

default:
  site_id: YOUR_ID
  username: YOUR_USERNAME
  secret: YOUR_KEY
  apiserver: https://api.cxense.com

Step 2: send a /traffic request by using CxQuery

import json
from pyCx import Cx, CxenseURL
from pyCx.helpers import date_range

cx = Cx(my_cx_config)

# get CxQuery object from Cx
query = cx.get_query()

# apply date range for what we want, here will get data from 11/01 to 11/30 (include).
dates = date_range('2018-11-01', '2018-12-01')

# remember do a reset() before a new request.
status, header, content = query.reset() \
    .uri(CxenseURL.TRAFFIC) \
    .add_filter({'type': 'and', 'filters': [{'group': "PREFIX-articleid", 'items': ['123405'], 'type': "keyword"}]}) \
    .add_fields(['events', 'uniqueUsers']) \
    .add_history_fields(['events', 'uniqueUsers']) \
    .add_dates(dates) \
    .send()

# print results
result = json.loads(content.decode('utf-8'))
print(result)

Docs

TODO

Contributors

kilfu0701

Lastest Version

0.0.11 (Lastest, 2018/12/13)

other releases

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyCx-0.0.12.tar.gz (7.4 kB view details)

Uploaded Source

File details

Details for the file pyCx-0.0.12.tar.gz.

File metadata

  • Download URL: pyCx-0.0.12.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for pyCx-0.0.12.tar.gz
Algorithm Hash digest
SHA256 1ba6f231d7c1d395e49c2051ae522c3dfbafb12ac19e7e3e38d2aeeba9de92cc
MD5 77e0f2dcc6aac4e793c5099adff92b7f
BLAKE2b-256 f866dae2dc7e9c2d8935d64a868bd79ea28ee3fafc60fe1da0e39032b7c04e14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page