{"id":15392622,"url":"https://github.com/jackdbd/ackee-action","last_synced_at":"2025-10-18T10:48:07.496Z","repository":{"id":50246005,"uuid":"368657088","full_name":"jackdbd/ackee-action","owner":"jackdbd","description":"GitHub action to generate an Ackee analytics report","archived":false,"fork":false,"pushed_at":"2021-05-31T15:00:33.000Z","size":359,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-17T21:29:28.152Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jackdbd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2021-05-18T20:22:17.000Z","updated_at":"2021-05-29T22:17:47.000Z","dependencies_parsed_at":"2023-01-04T14:15:40.183Z","dependency_job_id":null,"html_url":"https://github.com/jackdbd/ackee-action","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.1333333333333333,"last_synced_commit":"89eea49457c08458bae7e7bb3919bf99d31ec23a"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackdbd%2Fackee-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackdbd%2Fackee-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackdbd%2Fackee-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackdbd%2Fackee-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jackdbd","download_url":"https://codeload.github.com/jackdbd/ackee-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242988012,"owners_count":20217534,"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-10-01T15:15:25.431Z","updated_at":"2025-10-18T10:48:07.409Z","avatar_url":"https://github.com/jackdbd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ackee Analytics Action 📊 📈\n\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Coventional Commits guidelines](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://www.conventionalcommits.org/en/v1.0.0/) ![ci workflow](https://github.com/jackdbd/ackee-action/actions/workflows/ci.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/jackdbd/ackee-action/badge.svg?branch=main)](https://coveralls.io/github/jackdbd/ackee-action?branch=main) [![CodeFactor](https://www.codefactor.io/repository/github/jackdbd/ackee-action/badge)](https://www.codefactor.io/repository/github/jackdbd/ackee-action)\n\nGitHub action to generate an Ackee analytics report.\n\n## Inputs\n\n### `endpoint`\n\n**Required** — The URL for the /api endpoint of your Ackee GraphQL API server. Example: `https://demo.ackee.electerious.com/api`\n\n### `username`\n\n**Required** — The username that you use to authenticate with your GraphQL API server.\n\n### `password`\n\n**Required** — The password that you use to authenticate with your GraphQL API server.\n\n### `domain_id`\n\n**Required** — The ID of the domain you are monitoring with Ackee.\n\n### `num_top_pages`\n\nOptional — The top-performing N pages of the domain. Defaults to `10`.\n\n### `query`\n\nOptional — A custom GraphQL query. Maybe use the [Ackee demo](https://demo.ackee.electerious.com/api) to come up with your custom GraphQL query.\n\nFor example:\n\n```graphql\nquery getTop10BrowsersOfLast6Months {\n  domains {\n    statistics {\n      browsers(sorting: TOP, type: WITH_VERSION, range: LAST_6_MONTHS, limit: 10) {\n        id\n        count\n      }\n    }\n  }\n}\n```\n\n## Outputs\n\n### `data`\n\nThe `data` key of the response body received from the Ackee GraphQL API server.\n\n## Basic Usage\n\n```yaml\nsteps:\n  - name: Fetch analytics data from an Ackee GraphQL API server\n    id: ackee\n    uses: jackdbd/ackee-action@v1.1.0\n    with:\n      endpoint: ${{ secrets.ACKEE_API_ENDPOINT }}\n      username: ${{ secrets.ACKEE_USERNAME }}\n      password: ${{ secrets.ACKEE_PASSWORD }}\n      domain_id: ${{ secrets.ACKEE_DOMAIN_ID }}\n  - name: Dump data\n    run: echo ${{ steps.ackee.outputs.data }}\n```\n\n## Examples\n\n### Ackee =\u003e Telegram weekly report\n\n```yaml\nname: 'Ackee to Telegram weekly'\n\non:\n  schedule:\n    # https://crontab.guru/once-a-week\n    - cron:  '0 0 * * 0'\n\njobs:\n  ackee-weekly-report:\n    name: 7️⃣ Ackee weekly report\n    runs-on: ubuntu-latest\n    steps:\n      - name: ⬇️ Fetch data from Ackee\n        id: ackee\n        uses: jackdbd/ackee-action@v1.1.0\n        with:\n          endpoint: ${{ secrets.ACKEE_API_ENDPOINT }}\n          username: ${{ secrets.ACKEE_USERNAME }}\n          password: ${{ secrets.ACKEE_PASSWORD }}\n          domain_id: ${{ secrets.ACKEE_DOMAIN_ID }}\n      - name: 📳 Send report to Telegram\n        uses: appleboy/telegram-action@master\n        # https://github.com/appleboy/telegram-action\n        # This is a container action, so it must run on Linux (it would fail if\n        # `runs-on` is either `windows-latest` or `macos-latest`)\n        env:\n          ACKEE_REPORT: ${{ steps.ackee.outputs.data }}\n        with:\n          to: ${{ secrets.TELEGRAM_TO }}\n          token: ${{ secrets.TELEGRAM_TOKEN }}\n          message: |\n            🚀 Ackee weekly report!\n\n            ${{ env.ACKEE_REPORT }}\n```\n\n### Ackee =\u003e Slack on demand report\n\n```yaml\nname: 'Ackee to Slack on demand'\n\non:\n  # allow to trigger this workflow manually\n  workflow_dispatch:\n\njobs:\n  ackee-on-demand-report:\n    name: Send report on demand\n    runs-on: ubuntu-latest\n    steps:\n      - name: Fetch data from Ackee\n        id: ackee\n        uses: jackdbd/ackee-action@v1.1.0\n        with:\n          endpoint: ${{ secrets.ACKEE_API_ENDPOINT }}\n          username: ${{ secrets.ACKEE_USERNAME }}\n          password: ${{ secrets.ACKEE_PASSWORD }}\n          domain_id: ${{ secrets.ACKEE_DOMAIN_ID }}\n      - name: Send report to Slack\n        uses: pullreminders/slack-action@master\n        # https://github.com/abinoda/slack-action\n        # This is a container action, so it must run on Linux\n        env:\n          ACKEE_REPORT: ${{ steps.ackee.outputs.data }}\n          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}\n          SLACK_CHANNEL_ID: ${{ secrets.SLACK_CHANNEL_ID }}\n        with:\n          args: '{\\\"channel\\\":\\\"${{ env.SLACK_CHANNEL_ID }}\\\",\\\"text\\\":\\\"${{ env.ACKEE_REPORT }}\\\"}'\n```\n\nYou could use the [GitHub CLI](https://github.com/cli/cli) to trigger the workflow\n\n```sh\n# maybe pick a shorter name for your workflow ;-)\ngh workflow run 'Ackee to Slack on demand'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackdbd%2Fackee-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjackdbd%2Fackee-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackdbd%2Fackee-action/lists"}