{"id":19045508,"url":"https://github.com/yoast/singer-tap-postmark","last_synced_at":"2026-05-10T04:30:18.706Z","repository":{"id":48856849,"uuid":"348268503","full_name":"Yoast/singer-tap-postmark","owner":"Yoast","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-28T15:32:29.000Z","size":77,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"development","last_synced_at":"2025-01-02T08:31:17.354Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Yoast.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-16T08:27:50.000Z","updated_at":"2022-07-05T13:23:01.000Z","dependencies_parsed_at":"2024-11-08T22:50:28.274Z","dependency_job_id":"e83feb2c-aec5-4ab6-a91b-66075547a972","html_url":"https://github.com/Yoast/singer-tap-postmark","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-postmark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-postmark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-postmark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoast%2Fsinger-tap-postmark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yoast","download_url":"https://codeload.github.com/Yoast/singer-tap-postmark/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240102167,"owners_count":19747958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T22:50:26.018Z","updated_at":"2026-05-10T04:30:18.653Z","avatar_url":"https://github.com/Yoast.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tap-postmark\n\nThis is a [Singer](https://singer.io) tap that produces JSON-formatted data\nfollowing the [Singer\nspec](https://github.com/singer-io/getting-started/blob/master/SPEC.md).\n\nThis tap:\n\n- Pulls raw data from [Postmark](https://postmarkapp.com/developer)\n- Extracts the following resources:\n  - [Messages opens](https://postmarkapp.com/developer/api/messages-api#message-opens)\n  - [Messages outbound](https://postmarkapp.com/developer/api/messages-api#outbound-message-search)\n  - [Stats outbound bounces](https://postmarkapp.com/developer/api/stats-api#bounce-counts)\n  - [Stats outbound clients](https://postmarkapp.com/developer/api/stats-api#email-client-usage)\n  - [Stats outbound overview](https://postmarkapp.com/developer/api/stats-api#overview)\n  - [Stats outbound platform](https://postmarkapp.com/developer/api/stats-api#email-platform-usage)\n- Outputs the schema for each resource\n- Incrementally pulls data based on the input state\n\n### Step 1: Create an API key\n\nCreate an API key in Postmark\n\n### Step 2: Configure\n\nCreate a file called `postmark_config.json` in your working directory, following [sample_config.json](sample_config.json). The required parameters is the `postmark_server_token`.\n\nThis requires a `state.json` file to let the tap know from when to retrieve data. For example:\n```\n{\n  \"bookmarks\": {\n    \"messages_opens\": {\n      \"start_date\": \"2021-03-01\"\n    },\n    \"messages_outbound\": {\n      \"start_date\": \"2021-03-01\"\n    },\n    \"stats_outbound_bounces\": {\n      \"start_date\": \"2021-01-01\"\n    },\n    \"stats_outbound_clients\": {\n      \"start_date\": \"2021-01-01\"\n    },\n    \"stats_outbound_overview\": {\n      \"start_date\": \"2021-01-01\"\n    },\n    \"stats_outbound_platform\": {\n      \"start_date\": \"2021-01-01\"\n    }\n  }\n}\n```\nWill replicate data from those dates. Please note that the messages endpoints start date can be at maximum 45 days in the past.\n\n### Step 3: Install and Run\n\nCreate a virtual Python environment for this tap. This tap has been tested with Python 3.7, 3.8 and 3.9 and might run on future versions without problems.\n```\npython -m venv singer-postmark\nsinger-postmark/bin/python -m pip install --upgrade pip\nsinger-postmark/bin/pip install git+https://github.com/Yoast/singer-tap-postmark.git\n```\n\nThis tap can be tested by piping the data to a local JSON target. For example:\n\nCreate a virtual Python environment with `singer-json`\n```\npython -m venv singer-json\nsinger-json/bin/python -m pip install --upgrade pip\nsinger-json/bin/pip install target-json\n```\n\nTest the tap:\n\n```\nsinger-postmark/bin/tap-postmark --state state.json -c postmark_config.json | singer-json/bin/target-json \u003e\u003e state_result.json\n```\n\nCopyright \u0026copy; 2021 Yoast","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoast%2Fsinger-tap-postmark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoast%2Fsinger-tap-postmark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoast%2Fsinger-tap-postmark/lists"}