{"id":22180668,"url":"https://github.com/jftuga/quautomatrics","last_synced_at":"2025-03-24T18:46:14.474Z","repository":{"id":65189777,"uuid":"334957823","full_name":"jftuga/quautomatrics","owner":"jftuga","description":"Command-line automation of Qualtrics™ surveys","archived":false,"fork":false,"pushed_at":"2023-02-25T04:47:31.000Z","size":83,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-29T23:29:55.060Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/jftuga.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-02-01T13:25:08.000Z","updated_at":"2023-02-25T04:46:55.000Z","dependencies_parsed_at":"2024-06-20T02:56:27.541Z","dependency_job_id":"0ee72ded-5d23-4a28-9647-ca09559125f5","html_url":"https://github.com/jftuga/quautomatrics","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jftuga%2Fquautomatrics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jftuga%2Fquautomatrics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jftuga%2Fquautomatrics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jftuga%2Fquautomatrics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jftuga","download_url":"https://codeload.github.com/jftuga/quautomatrics/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245332067,"owners_count":20598099,"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-12-02T09:19:04.762Z","updated_at":"2025-03-24T18:46:14.447Z","avatar_url":"https://github.com/jftuga.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quautomatrics\nCommand-line automation of Qualtrics™ surveys\n\n### Usage\n\n```\nQuautomatrics can perform basic operations on Qualtrics™ contacts, mailing lists, distributions, and responses\n\nUsage:\n  quautomatrics [command]\n\nAvailable Commands:\n  createContacts     Add contacts to a mailing list\n  createDistribution Create a distribution file in JSON format\n  deleteContacts     Remove all contacts from a mailing list\n  exportResponses    Export survey responses in CSV format\n  help               Help about any command\n  listLibraries      List all libraries. A library is needed in order to create a Distribution.\n  listMailingLists   Get a mailing-list ID\n  listSurveys        Get a survey ID.\n  replaceContacts    Replace all mailing list entries with CSV entries\n  uploadDistribution Upload a distribution file\n\nFlags:\n      --config string   config file (default is quautomatrics_config.json)\n  -h, --help            help for quautomatrics\n  -v, --version         version for quautomatrics\n\nUse \"quautomatrics [command] --help\" for more information about a command.\n\n\n```\n\n### Prerequisites\n* A Qualtrics™ account with access to the `Research Core Contacts` API.\n* * This program **does not** use the `XM Directory` API.\n* You will need an `API Token` which is located under:\n* * `Account Settings` =\u003e `Qualtrics IDs` =\u003e `API`\n* Your `Datacenter ID` which is located under:\n* * `Account Settings` =\u003e `Qualtrics IDs` =\u003e `User`\n\n### Examples\n\n* Rename `quautomatrics_config-dist.json` to `quautomatrics_config.json`\n* * Edit these fields: `X-API-TOKEN`, `DATACENETR`\n* A `CSV` file must use this format, with no header line:\n* * `first name,last name,email address`\n    \nA survey `mailing list` must already be created through the Qualtrics web interface.\nIn the examples below it is called `My_Fancy_Survey`.\n\n**Adding Contacts**\n```shell\nquautomatrics createContacts -m My_Fancy_Survey -c people.csv\n```\n\n**Removing All Contacts**\n```shell\nquautomatrics deleteContacts -m My_Fancy_Survey\n```\n\n**Replace Contacts**\n* This will first remove all contacts and then add new contacts from a `CSV` file.\n\n```shell\nquautomatrics replaceContacts -m My_Fancy_Survey -c newPeople.csv\n```\n\n**List**\n* The `listLibraries`, `listMailingLists` and `listSurveys` commands will list all items returned by the API.\n* * The `-n` command-line switch can also be used to limit the listing to just one entry.\n    \n```shell\nquautomatrics listLibraries\n\nlibraryId: UR_12xxxxxxxxxxxxx  name: Test Library\nlibraryId: GR_34xxxxxxxxxxxxx  name: Qualtrics Library\n```\n\n* To list all messages within an individual library, use the `-M` switch.\n\n```shell\nquautomatrics.exe listLibraries -n \"Test Library\" -M\n\nlibraryId: UR_12xxxxxxxxxxxxx\nmessageId: MS_45xxxxxxxxxxxxx  name: Invite A\nmessageId: MS_56xxxxxxxxxxxxx  name: Invite B\nmessageId: MS_67xxxxxxxxxxxxx  name: Invite C\n```\n\n**Contents of quautomatrics_config.json**\n```json\n{\n  \"X-API-TOKEN\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"DATACENTER\": \"zz1\",\n  \"fromName\": \"My Company Name\",\n  \"replyToEmail\": \"noreply@qualtrics.com\",\n  \"fromEmail\": \"noreply@qualtrics.com\",\n  \"subject\": \"Please take our survey\"\n}\n```\n\n**Creating a Distribution**\n```shell\nquautomatrics.exe createDistribution -c quautomatrics_config.json -o distribution.json -l \"Inquiry Survey\" \n-m \"Invitation Email\" -n \"My_Contacts\"  -s \"My_Fancy_Survey\" -d \"_NOW_\" -e \"_DAYS:5_T23:59:59Z\"\n```\n\n**Uploading a Distribution**\n```shell\nquautomatrics.exe uploadDistribution -d distribution.json\n```\n\n**Export Survey Responses to a CSV File**\n```shell\nquautomatrics.exe exportResponses -s My_Fancy_Survey\n[1] waiting for survey export completion...\n[2] waiting for survey export completion...\nSaved CSV file: My_Fancy_Survey.csv\n```\n\n### Date-Time Macros\n\nThese macros can be used in the `createDistribution` command with the `-d` and `-e` options:\n\n| Macro         | Description \n|---------------|------------- \n| `_NOW_`       | replaced with current date/time such as `2006-01-02T15:04:05Z` |\n| `_TODAY_`     | replaced with current date such as `2006-01-02` |\n| `_YMD_`       | same as `_TODAY_` |\n| `_HMS_`       | replaced with current time such as `15:04:05` | \n| `_TOMORROW_`  | replaced with tomorrow's date such as `2006-01-03` | \n| `_DAYS:n_`    | replaced with *n* days into the future; when n=3 then `2006-01-05` |\n\n### API\n\nThis program **does not** use the XM Directory API. Instead, it uses the `Research Core Contacts` API.\n\nAPIs used:\n\n* [Create Distribution](https://api.qualtrics.com/instructions/reference/distributions.json/paths/~1distributions/post)\n* [List Libraries](https://api.qualtrics.com/instructions/reference/libraries.json/paths/~1libraries/get)\n* [List Library Messages](https://api.qualtrics.com/instructions/reference/libraries.json/paths/~1libraries~1%7BlibraryId%7D~1messages/get)\n* [List Mailing Lists](https://api.qualtrics.com/instructions/reference/researchCore.json/paths/~1mailinglists/get)\n* [Update Mailing List](https://api.qualtrics.com/instructions/reference/researchCore.json/paths/~1mailinglists~1%7BmailingListId%7D/put)\n* [List Contacts](https://api.qualtrics.com/instructions/reference/researchCore.json/paths/~1mailinglists~1%7BmailingListId%7D~1contacts/get)\n* [Delete Contacts](https://api.qualtrics.com/instructions/reference/researchCore.json/paths/~1mailinglists~1%7BmailingListId%7D~1contacts~1%7BcontactId%7D/delete)\n* [Create Contacts](https://api.qualtrics.com/instructions/reference/researchCore.json/paths/~1mailinglists~1%7BmailingListId%7D~1contacts/post)\n* [Surveys Response Import/Export API](https://api.qualtrics.com/instructions/reference/responseImportsExports.json)\n\n### License\n* [MIT License](https://github.com/jftuga/quautomatrics/blob/main/LICENSE)\n\n### Acknowledgements\n* [cobra](https://github.com/spf13/cobra)\n* [viper](https://github.com/spf13/viper)\n* * [go-homedir](https://github.com/mitchellh/go-homedir) \n* [jsonparser](https://github.com/buger/jsonparser)\n* **Please note that there is no official affiliation between Qualtrics™ and `quautomatrics`**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjftuga%2Fquautomatrics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjftuga%2Fquautomatrics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjftuga%2Fquautomatrics/lists"}