• Home
    • Pugpig Bolt
    • Content and Workflows

    Pugpig Monitoring API

    The API Provided to allow Enterprise customers to monitor the status of Distribution Jobs

    Written by Jon Marks

    Updated at July 17th, 2023

    • Pugpig Bolt

      • Pugpig Site

        • Pugpig Archive

          • Working with Pugpig

            • Pugpig Consulting

              Table of Contents

              Overview Endpoints Activity Log In Progress Actions Completed Actions

              Overview

              The Pugpig Distribution Service allows Enterprise customers to make API calls to allow you to see the status and progress of publishing jobs. These are the same API calls made on the Distribution interface to allow you to see the in progress jobs, and the recent failures.

              The calls are all of this form:

              https://<account_code>.admin.pugpig.com/publication/<publication_code>/addon/<endpoint_prefix>.<publication_code>.<account_code>/

              Where:

              account_code is your account code in the distribution service
              publication_code is the publication code in the distribution service
              endpoint_prefix is the endpoint prefix set in distribution, usually this will be something like, 'main' or 'prod'
              api_key is the unique identifier for your Pugpig Distribution Service account

              You can see a summary of the values for your publication here:

              https://<account_code>.admin.pugpig.com/publication/<publication_code>/addon/<endpoint_prefix>.<publication_code>.<account_code>/specification - there is a link from the Help here too:

              Endpoints

              We provide the following endpoints. These should not be polled more than once every 60 seconds, and only while a job is in process. When no jobs are in processes, they should not be polled more than once every 5 minutes.

              Activity Log

              Returns a log of activities. All the triggered action notifications, warnings and errors.

              GET /baseurl/activity

              In Progress Actions

              Returns a list of actions in progress, as well as the progress data.

              /GET /baseurl/progress.json

              Completed Actions

              Returns a list of the completed actions and its status data.

              /GET /baseurl/completed.json


              api pugpig

              Was this article helpful?

              Yes
              No
              Give feedback about this article

              Related Articles

              • Distribution Overview - Pugpig Domains
              • Article cache times in your app
              • Live Blog Content
              pugpig logo white
              Navigation
              • Products
              • Customers
              • News
              • Podcast
              Contact
              • Contact us
              • LinkedIn
              • Twitter
              Technical Support
              • Status Page
              • Documentation
              • Customer Support
              Corporate
              • Company
              • Jobs
              • Privacy Policy

              © Kaldor Ltd. 2022

              Powered by Pugpig


              Knowledge Base Software powered by Helpjuice

              Expand