Skip to main content

This is a package for requesting and processing data from Solvis's results API.

Project description

Solvis Results API

This is a package for requesting and processing data from Solvis's results API. The package is designed to handle complex nested data structures, efficiently transforming them into a tabular format (pandas dataframe) suitable for analysis.

Features

  • Request data from the following endpoints:
    • Devices
    • Evaluations
    • Questionnaire
    • Surveyed Units
    • Suspicious Occurrences
  • Converts nested data into a flat pandas dataframe.
  • Handles various evaluations question types, including:
    • NPS (Net Promoter Score)
    • Scale
    • Multiple Choice
    • Text and Short Text
    • Multiple Response
    • Special Types (Phone, CPF, CNPJ, Email)
  • Robust handling of unexpected or malformed data.
  • Logging for process tracking and debugging.

Installation

Install the package via pip (or your favorite package manager):

pip install solvis-results-api

Usage

Importing the Module

from solvis_results_api import GetEvaluations, ProcessEvaluations

Example

# Initialize modules
api = GetEvaluations()
processor = ProcessEvaluations()

# Request API
evaluations = api.get_evaluations(
    user='',
    password='',
    survey_id='',
    start_datetime='2025-01-01T00:00:00',
    end_datetime='2025-01-31T23:59:59',
)

# Process the data
df = processor.process_evaluations(evaluations)

# Print output
print(df)

Dependencies

  • Python 3.12+
  • Pandas
  • Requests

Contact

For questions or feedback, feel free to reach out:

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

solvis_results_api-0.1.6b0.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

solvis_results_api-0.1.6b0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file solvis_results_api-0.1.6b0.tar.gz.

File metadata

File hashes

Hashes for solvis_results_api-0.1.6b0.tar.gz
Algorithm Hash digest
SHA256 bd6fd2e790e722ff8a5c7f620d1586e77549550e47c0a4e6217858b6deee00de
MD5 6022417a0d94901ea3d53674fc7c5f5b
BLAKE2b-256 4646a9d1e818c3e01c415976f27700793f3fe751304664e58876ed67d21c179b

See more details on using hashes here.

File details

Details for the file solvis_results_api-0.1.6b0-py3-none-any.whl.

File metadata

File hashes

Hashes for solvis_results_api-0.1.6b0-py3-none-any.whl
Algorithm Hash digest
SHA256 8612028ce717d21166bf3d7253d2e0c4b6d8e083af0e68c2efe3af4c4384bca6
MD5 53b56c815a23cb7da76dd5f84fe9f5a2
BLAKE2b-256 9ff2500eadf0615ffb66e07c4d2cb8810e0b37c33fb9ea22ead026e3c1edb363

See more details on using hashes here.

Supported by

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