tap-dataai
is a Singer tap for API of the data.ai service. Now it can download such reports as: app-performance
.
Built with the Meltano Tap SDK for Singer Taps.
Setting | Required | Default | Description |
---|---|---|---|
auth_token | True | None | The token to authenticate against the API service |
type_report | True | None | Must be product_id or company_id. |
type_values | True | None | Ids of the products or companies (comma separated string). |
granularity | True | None | The granularity of the report (monthly, weekly, daily). |
countries | True | None | Countries in the report (comma separated string). |
bundles | True | None | Bundles in the report. |
devices | False | all_supported | Devices in the report. |
start_date | True | None | The earliest record date to sync |
end_date | True | None | The latest record date to sync |
A full list of supported settings and capabilities for this tap is available by running:
tap-dataai --about
This Singer tap will automatically import any environment variables within the working directory's
.env
if the --config=ENV
is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the .env
file.
You can easily run tap-dataai
by itself or in a pipeline using Meltano.
tap-dataai --version
tap-dataai --help
tap-dataai --config CONFIG --discover > ./catalog.json
Follow these instructions to contribute to this project.
pipx install poetry
poetry install
Create tests within the tap_dataai/tests
subfolder and
then run:
poetry run pytest
You can also test the tap-dataai
CLI interface directly using poetry run
:
poetry run tap-dataai --help
Testing with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-dataai
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-dataai --version
# OR run a test `elt` pipeline:
meltano elt tap-dataai target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.