Follow

API Documentation

Apmetrix API Commands

Accounts

What it does: Returns all Accounts this user has access to.

    • URL

      GET /accounts

    • Header Params

      None

    • Body Params

      None

 

Account Info

What it does: Returns indepth info on specific Accounts

    • URL

      GET /accountinfo

    • Header Params

      • None = return all info for all acounts you have access to (can be very large)
      • compact = a smaller set of info per account (note: the value does not matter)
      • accountid= info on only that account
    • Body Params

      None

 

LogOut

What it does: Logs out of Apmetrix

    • URL

      GET /logout

    • Header Params

      None

    • Body Params

      None

 

Query

What it does: Process a query of your data

    • URL

      POST /query

    • Header Params

      • appid = Application ID
      • type = BODY being sent is in XML or SQL format
      • start = Start date of Query (dates are in YYYY-MM-DD (or YYYYMMDD) format)
      • end = End date of Query Note: Dates are required but ignored if the sql contains dates
    • Body Params

      XML or SQL based on what you put in type

 

Report

What it does: Gets a Report

        • URL

          GET /report

        • Header Params

          • appid = Application ID
          • reportid= ID of the report to load

          optional

          • version = version of the report to load
        • Body Params

          None

What it does: Delete's a Report

        • URL

          DELETE /report

        • Header Params

          • name = Name of report
          • reportid= id of Report to delete
        • Body Params

          None

What it does: Save's a Report

        • URL

          PUT /report

        • Header Params

          • name = Name of report
          • description= Description of report
          • appid = Application ID of the report
          • screenshot= URL of Screen Shot (saved with Save Image)

optional

  • id = Current ID of report to save (otherwise it's a save as)
  • published= make report available to others in this Application
  • menuname= directory tree of report
    • Body Params

      JSON String of report to save

 

Report List

What it does: Get a list of reports this user has access to

    • URL

      GET /reportlist

    • Header Params

      • appid = Application ID
    • Body Params

      None

 

Save Image

What it does: Saves an image

      • URL

        PUT /saveimage

      • Header Params

        • None

optional

  • crop = crop for optimal screenshot size picture of report (size pre-determined)
  • filename= saving an existing image (a new filename will be returned, and the existing file will be deleted. This is done for caching purposes)

 

  • Body Params

    Mime/Base64 encoded image

    example = data:image/png;base64,xYzpdQ...

 

 

Table List

What it does: Gets a list of tables this user has access to

    • URL

      GET /tablelist

    • Header Params

      • appid = Application ID
    • Body Params

      None

 

Update Password

What it does: Updates the password for a user (Access is checked based on the user whose token this is)

    • URL

      PUT /password

    • Header Params

      • email = email address of the user whose password you want to change
      • password= new password for that user
    • Body Params

      None

 

User Info

What it does: Get's all info about this user (can be quite large)

      • URL

        GET /userinfo

      • Header Params

        • appid = Application ID

optional

  • compact = smaller version of info
  • addroles= include roles

 

  • Body Params

    None

 

 

User Tables

What it does: List of tables the user has created

    • URL

      GET /usertables

    • Header Params 

      • None
    • Body Params

      None




Have more questions? Submit a request