Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.45 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.45 KB

Python Helpshift API Sample Code

This projects contains the sample code for using Helpshift API to create an issue, add message with attachment, and export API response to csv files in Python.

Setup and Usage Instructions

  1. To use the sample code, Python 2 should be installed.

  2. Install the project dependencies using below command.

    pip install -r requirements.txt

  3. Retrieve your Helsphift API key.

  4. Replace DOMAIN, API_KEY, ATTACHMENT_FILE_PATH, TEST_PAYLOAD, ISSUE_FILE_LOCATION and MESSAGES_FILE_LOCATION, as required, in create_issue_with_attachment.py , add_message_with_attachment.py and export_issues_to_csv.py with actual values.

  5. Create issue by using following command and note the issue_id.

    python create_issue_with_attachment.py

  6. Add message to issue using following command. This script accepts an issue_id.

    python add_message_with_attachment.py <ISSUE_ID>

  7. Export all issues and messages created in the last given number of days into separate files using following command.

    python export_issues_to_csv.py <NO_OF_DAYS>