Python SDK for the Highspot API

Welcome to the official documentation for the Python SDK for the Highspot API.

Table of Contents

• Change Log

• Highspot Core Object
  • Init Module (highspot)
    • Highspot
      • Highspot.Domain
        • Highspot.Domain.__init__()
        • Highspot.Domain.get_custom_usage_labels()
        • Highspot.Domain.get_promoted_search_results()
      • Highspot.Group
        • Highspot.Group.__init__()
        • Highspot.Group.get_group()
        • Highspot.Group.get_groups()
      • Highspot.Item
        • Highspot.Item.__init__()
        • Highspot.Item.get_cms_metadata()
        • Highspot.Item.get_item()
        • Highspot.Item.get_item_bookmarks()
        • Highspot.Item.get_item_content()
        • Highspot.Item.get_item_properties()
        • Highspot.Item.get_item_property()
        • Highspot.Item.get_item_report()
        • Highspot.Item.get_item_thumbnails()
        • Highspot.Item.get_items()
      • Highspot.Pitch
        • Highspot.Pitch.__init__()
        • Highspot.Pitch.get_pitches()
      • Highspot.Request
        • Highspot.Request.__init__()
        • Highspot.Request.get_request_result()
        • Highspot.Request.get_request_status()
      • Highspot.Spot
        • Highspot.Spot.__init__()
      • Highspot.User
        • Highspot.User.__init__()
        • Highspot.User.get_user()
        • Highspot.User.get_user_properties()
        • Highspot.User.get_user_property()
        • Highspot.User.get_users()
        • Highspot.User.me()
      • Highspot.__init__()
      • Highspot.get()
  • Core Module (highspot.core)
    • Highspot
      • Highspot.Domain
        • Highspot.Domain.__init__()
        • Highspot.Domain.get_custom_usage_labels()
        • Highspot.Domain.get_promoted_search_results()
      • Highspot.Group
        • Highspot.Group.__init__()
        • Highspot.Group.get_group()
        • Highspot.Group.get_groups()
      • Highspot.Item
        • Highspot.Item.__init__()
        • Highspot.Item.get_cms_metadata()
        • Highspot.Item.get_item()
        • Highspot.Item.get_item_bookmarks()
        • Highspot.Item.get_item_content()
        • Highspot.Item.get_item_properties()
        • Highspot.Item.get_item_property()
        • Highspot.Item.get_item_report()
        • Highspot.Item.get_item_thumbnails()
        • Highspot.Item.get_items()
      • Highspot.Pitch
        • Highspot.Pitch.__init__()
        • Highspot.Pitch.get_pitches()
      • Highspot.Request
        • Highspot.Request.__init__()
        • Highspot.Request.get_request_result()
        • Highspot.Request.get_request_status()
      • Highspot.Spot
        • Highspot.Spot.__init__()
      • Highspot.User
        • Highspot.User.__init__()
        • Highspot.User.get_user()
        • Highspot.User.get_user_properties()
        • Highspot.User.get_user_property()
        • Highspot.User.get_users()
        • Highspot.User.me()
      • Highspot.__init__()
      • Highspot.get()
    • Core Functionality Subclasses (highspot.core.Highspot)
      • Domain Subclass (highspot.core.Highspot.Domain)
      • Groups Subclass (highspot.core.Highspot.Group)
      • Items Subclass (highspot.core.Highspot.Item)
      • Pitches Subclass (highspot.core.Highspot.Pitch)
      • Request Subclass (highspot.core.Highspot.Request)
      • Spots Subclass (highspot.core.Highspot.Spot)
      • Users Subclass (highspot.core.Highspot.User)
• Primary Modules
  • Init Module (highspot)
  • Core Module (highspot.core)
  • API Module (highspot.api)
    • get_request_with_retries()
  • Domain Module (highspot.domain)
    • get_custom_usage_labels()
    • get_promoted_search_results()
  • Groups Module (highspot.groups)
    • get_group()
    • get_groups()
  • Items Module (highspot.items)
    • get_cms_metadata()
    • get_item()
    • get_item_bookmarks()
    • get_item_content()
    • get_item_properties()
    • get_item_property()
    • get_item_report()
    • get_item_thumbnails()
    • get_items()
  • Pitches Module (highspot.pitches)
    • get_pitches()
  • Request Module (highspot.request)
    • get_request_result()
    • get_request_status()
  • Spots Module (highspot.spots)
  • Users Module (highspot.users)
    • get_user()
    • get_user_properties()
    • get_user_property()
    • get_users()
    • me()
• Supporting Modules
  • Classes & Exceptions
    • Errors Module (highspot.errors)
      • Exceptions Module (highspot.errors.exceptions)
        • APIConnectionError
        • APIRequestError
        • CurrentlyUnsupportedError
        • DataMismatchError
        • HighspotError
        • InvalidFieldError
        • MissingAuthDataError
        • MissingRequiredDataError
      • Handlers Module (highspot.errors.handlers)
        • eprint()
  • Tools & Utilities
    • Logging Utilities Module (highspot.utils.log_utils)
      • LessThanFilter
        • LessThanFilter.filter()
      • initialize_logging()
    • Version Module (highspot.utils.version)
      • get_full_version()
      • get_major_minor_version()

Module Index and Search

• Index

• Module Index

• Search Page