Skip to main content

Python API wrapper for the Listrak API

Project description

listrak-api-wrapper

This is a wrapper for the Listrak API. This wrapper is meant to be used with the Listrak /email API

Note: This is a work in progress, not all endpoints are functional at the moment. Please see bottom of page for details.

Installation Instructions

Install Requirements (If Necessary)

  • The "requests" library is required to use this package.
pip install requests

Install Library

pip install listrak-api-wrapper

Usage Instructions

Create a Client

Note: This example assumes the LISTRAK_CLIENT_ID and LISTRAK_CLIENT_SECRET API credentials are saved as environment variables.

import os
from listrak import listrak


# Create listrak_api obj that will be used to authenticate with Listrak API
client_id = os.getenv("LISTRAK_CLIENT_ID")
client_secret = os.getenv("LISTRAK_CLIENT_SECRET")

listrak_api = listrak.Listrak(client_id, client_secret)

Example showing how to get all lists associated with your account.

lists = listrak_api.uri_list.get_all_lists()

Working

  • CONTACT
  • LIST
  • LISTIMPORT
  • SEGMENTATIONFIELD
  • SEGMENTATIONFIELDGROUP

Planned

  • CAMPAIGN (N/A)
  • CONVERSATION (N/A)
  • CONVERSATIONMESSAGE (N/A)
  • CONVERSATIONMESSAGEACTIVITY (N/A)
  • CONVERSATIONMESSAGELINK (N/A)
  • CONVERSATIONMESSAGELINKCLICKER (N/A)
  • CONVERSATIONMESSAGESUMMARY (N/A)
  • CONVERSATIONSUMMARY (N/A)
  • EVENT (N/A)
  • EVENTGROUP (N/A)
  • FOLDER (N/A)
  • IPPOOL (N/A)
  • LISTIMPORTCONTACT (N/A)
  • LISTIMPORTSTATUS (N/A)
  • LISTIMPORTSUMMARY (N/A)
  • MESSAGE (N/A)
  • MESSAGEACTIVITY (N/A)
  • MESSAGELINK (N/A)
  • MESSAGELINKCLICKER (N/A)
  • MESSAGESTATUS (N/A)
  • MESSAGESUMMARY (N/A)
  • SAVEDAUDIENCE (N/A)
  • SAVEDMESSAGE (N/A)
  • TRANSACTIONALMESSAGE (N/A)
  • TRANSACTIONALMESSAGEACTIVITY (N/A)
  • TRANSACTIONALMESSAGERESEND (N/A)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

listrak-api-wrapper-0.1.5.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

listrak_api_wrapper-0.1.5-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file listrak-api-wrapper-0.1.5.tar.gz.

File metadata

  • Download URL: listrak-api-wrapper-0.1.5.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.6

File hashes

Hashes for listrak-api-wrapper-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fa6431a73ff9cd3a8fc66facbe0dd30f04725296004466b41fd72fbb7a7c8958
MD5 adcd923b5fad660eca76c7c60aaf1b9d
BLAKE2b-256 988c29f5d638340924298779af64aa1123db88504159176bdd6d0cedbefcaf4c

See more details on using hashes here.

File details

Details for the file listrak_api_wrapper-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for listrak_api_wrapper-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 114cd69ca297d63b4373a67e6494a911d66cb7f81df83246fbd4e2c436551605
MD5 cee6a53670abf4c7ac686a5de6acd69a
BLAKE2b-256 212c0b04c6ad008a8bec2148b40dc20fe725b63ced2efbaf61a3340c20368750

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page