List Templates
  • 12 Mar 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

List Templates

  • Dark
    Light
  • PDF

Article Summary

/profiles/{Profile ID}/templates/ returns a list of the template definitions (and their report definitions) that are associated with the specified profile.

Method: GET

URI: /profiles/{Profile ID}/templates/

Note: Add any optional parameters to the end of the URI. If you change the order of URI or required parameters, or place optional parameters before them, the call will not work.

Example Request
https://myDomain.com/v2_0/ReportService/profiles/K729vc8Qqj5/templates/?format=xml&suppress_error_codes=true

Example Response

<list>
  <Template>
    <string name="ID">7cqana568rn</string>
    <string name="Name">Complete View</string>
    <string name="Description">Complete View</string>
    <decimal name="AccountID">1</decimal>
    <list name="Reports">
      <ReportDefinition>
        <decimal name="accountID">1</decimal>
          <string name="name">Initial Search Engines</string>
          <string name="ID">uK4gTGvcNj5</string>
          <string name="Category">%%SearchEngines%%</string>
      </ReportDefinition>
    </list>
  </Template>
  <Template>
    <string name="ID">4c5afa568</string>
    <string name="Name">My  View</string>
    <string name="Description">My View</string>
    <decimal name="AccountID">1</decimal>
    <list name="Reports">
      <ReportDefinition>
        <decimal name="accountID">1</decimal>
          <string name="name">Initial Search Engines</string>
          <string name="ID">uK4gTGvcNj5</string>
          <string name="Category">%%SearchEngines%%</string>
      </ReportDefinition>
    </list>
  </Template>
</list>

Parameters:

format

format = return data format
Example: specifying data formats

Data formatParameter and value
JSONformat=json
XMLformat=xml
XML2 ("XPath-friendly" XML for dynamic applications)format=xml2
HTMLformat=html (use this when importing data into Excel)
CSVformat=csv (available for account-level and profile-level keymetrics)
RSSformat=rss (use to specify an RSS 2.0 syndication feed)
ATOMformat=atom (use to specify an ATOM 1.0 syndication feed)

For report data requests, all formats are supported. For "list" requests, only XML and JSON formats are supported.

suppress error codes

Set the suppress_error_codes parameter to true if you do not want to be notified of error conditions for a request (the default is false).

suppress_error_codes = {true|false}
Example: Suppress errors for a request
suppress_error_codes=true


Was this article helpful?