Package com.day.cq.analytics.sitecatalyst

Interface SitecatalystWebservice

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PN_COMPANY
      Property name for company
      static java.lang.String PN_PASSWORD
      Property name for password
      static java.lang.String PN_REPORTSUITE
      Property name for report suite
      static java.lang.String PN_REPORTSUITES
      Property name for report suites
      static java.lang.String PN_SECRET
      Property name for secret
      static java.lang.String PN_SERVER
      Property name for server
      static java.lang.String PN_USERNAME
      Property name for username

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void checkCredentials​(java.lang.String company, java.lang.String username, java.lang.String password)
      Deprecated.
      boolean deleteClassifications​(Configuration configuration, java.lang.String classificationView, java.lang.String[] reportSuites, int divNum, int parentDivNum)
      Deprecated.
      This method was used to support SAINT which is now deprecated.
      JSONArray getClassifications​(Configuration configuration, java.lang.String classificationView, java.lang.String[] reportSuites, int relationId)
      Deprecated.
      This method was used to support SAINT which is now deprecated.
      java.lang.String getEvars​(Configuration configuration, java.lang.String rsid)
      Returns a JSON representation of conversion variables (eVar's) for a report suite rsid.
      java.lang.String getLoginKey​(java.lang.String company, java.lang.String username, java.lang.String password)
      Deprecated.
      java.lang.String getLoginKey​(java.lang.String server, java.lang.String company, java.lang.String username, java.lang.String password)
      Deprecated.
      java.lang.String getMetrics​(Configuration configuration, java.lang.String rsID)
      Retrieves a list of possible valid elements for a report.
      java.lang.String getPages​(Configuration configuration, java.lang.Integer limit, java.lang.String pagename, java.lang.String rsid, java.lang.Integer start)
      Deprecated.
      The Analytics API no longer supports retrieving a list of pages from specified report suite starting with the 1.4 version.
      java.lang.String getReport​(Configuration configuration, java.lang.String reportID)
      Returns a report with report identifier reportID.
      java.lang.String getReportStatus​(Configuration configuration, java.lang.String reportID)
      Deprecated.
      Use getReport(Configuration, String) instead.
      java.lang.String getReportSuites​(Configuration configuration)
      Returns a JSON representation of report suites for a Configuration.
      java.lang.String getSegments​(java.lang.String server, java.lang.String company, java.lang.String username, java.lang.String secret)
      Gets all available segments using the required Analytics parameters.
      java.lang.String getSuccessEvents​(Configuration configuration, java.lang.String rsid)
      Returns a JSON representation of success events (event's) for the report suite rsid.
      java.lang.String getSynchronousReport​(Configuration configuration, java.lang.String reportType, JSONObject reportDescription)
      Deprecated.
      The Analytics API no longer supports synchronous reports starting with the 1.4 version.
      java.lang.String getTrackingServer​(Configuration configuration, java.lang.String rsid)
      Returns the tracking server URI for a specified ReportSuiteID ( rsid).
      java.lang.String getTrafficVars​(Configuration configuration, java.lang.String rsid)
      Returns a JSON representation of traffic variables (prop's) for a report suite rsid.
      java.lang.String queuePageViewReport​(Configuration configuration, java.lang.String rsid, java.lang.String date)
      Queues a report of type pageView for a report suite rsid and the report date date
      java.lang.String queueReport​(Configuration configuration, java.lang.String reportType, JSONObject reportDescription)
      Deprecated.
      Analytics API 1.4 no longer requires a report type as parameter for queueing reports.
      java.lang.String queueReport​(Configuration configuration, JSONObject reportDescription)
      Queues the execution of an Analytics report based on a given JSON reportDescription.
      boolean saveClassifications​(Configuration configuration, java.lang.String classificationView, boolean campaignView, java.lang.String name, int parentDivNum, java.lang.String[] reportSuites, boolean update)
      Deprecated.
      This method was used to support SAINT which is now deprecated.

    • Field Detail

      • PN_COMPANY

        static final java.lang.String PN_COMPANY
        Property name for company
        See Also:
        Constant Field Values

      • PN_USERNAME

        static final java.lang.String PN_USERNAME
        Property name for username
        See Also:
        Constant Field Values

      • PN_SECRET

        static final java.lang.String PN_SECRET
        Property name for secret
        See Also:
        Constant Field Values

      • PN_SERVER

        static final java.lang.String PN_SERVER
        Property name for server
        See Also:
        Constant Field Values

      • PN_PASSWORD

        static final java.lang.String PN_PASSWORD
        Property name for password
        See Also:
        Constant Field Values

      • PN_REPORTSUITE

        static final java.lang.String PN_REPORTSUITE
        Property name for report suite
        See Also:
        Constant Field Values

      • PN_REPORTSUITES

        static final java.lang.String PN_REPORTSUITES
        Property name for report suites
        See Also:
        Constant Field Values

    • Method Detail

      • checkCredentials

        @Deprecated
void checkCredentials​(java.lang.String company,
                      java.lang.String username,
                      java.lang.String password)
               throws SitecatalystException
        Deprecated.
        Checks SiteCatalyst credentials by issuing the API call Company.GetReportSuites.
        Parameters:
        company - Company
        username - Username
        password - Password
        Throws:
        SitecatalystException - - if an error occurs, authentication or authorization fails.

      • getLoginKey

        @Deprecated
java.lang.String getLoginKey​(java.lang.String company,
                             java.lang.String username,
                             java.lang.String password)
                      throws SitecatalystException
        Deprecated.
        Returns the login key (shared secret) for the provided company,username and password combination.
        Parameters:
        company - Company
        username - Username
        password - Password
        Returns:
        login key (shared secret) for the provided company,username and password combination.
        Throws:
        SitecatalystException - SitecatalystException

      • getLoginKey

        @Deprecated
java.lang.String getLoginKey​(java.lang.String server,
                             java.lang.String company,
                             java.lang.String username,
                             java.lang.String password)
                      throws SitecatalystException
        Deprecated.
        Returns the login key (shared secret) for the provided company,username and password combination.
        Parameters:
        server - Server end point URL
        company - Company
        username - Username
        password - Password
        Returns:
        login key (shared secret) for the provided company,username and password combination.
        Throws:
        SitecatalystException - SitecatalystException

      • getSegments

        java.lang.String getSegments​(java.lang.String server,
                             java.lang.String company,
                             java.lang.String username,
                             java.lang.String secret)
                      throws SitecatalystException
        Gets all available segments using the required Analytics parameters. This method can be used when the Analytics configuration is not available yet.
        Parameters:
        server - the Analytics data center to be used for the API call
        company - the Analytics company
        username - the Analytics user name
        secret - the Analytics webservice API shared secret
        Returns:
        a stringified JSON list of all the available Analytics segments
        Throws:
        SitecatalystException - if something goes wrong while calling the Analytics API for getting the segments

      • getTrackingServer

        java.lang.String getTrackingServer​(Configuration configuration,
                                   java.lang.String rsid)
                            throws SitecatalystException
        Returns the tracking server URI for a specified ReportSuiteID ( rsid).
        Parameters:
        configuration - Web service support configuration
        rsid - Report suite ID
        Returns:
        the tracking server URI for specified rsid
        Throws:
        SitecatalystException - SitecatalystException

      • getEvars

        java.lang.String getEvars​(Configuration configuration,
                          java.lang.String rsid)
                   throws SitecatalystException
        Returns a JSON representation of conversion variables (eVar's) for a report suite rsid.
        Parameters:
        configuration - Web service support configuration
        rsid - Report suite ID
        Returns:
        JSON representation of conversion variables for rsid
        Throws:
        SitecatalystException - SitecatalystException

      • getTrafficVars

        java.lang.String getTrafficVars​(Configuration configuration,
                                java.lang.String rsid)
                         throws SitecatalystException
        Returns a JSON representation of traffic variables (prop's) for a report suite rsid.
        Parameters:
        configuration - Web service support configuration
        rsid - Report suite ID
        Returns:
        TrafficVars for rsid
        Throws:
        SitecatalystException - SitecatalystException

      • queueReport

        @Deprecated
java.lang.String queueReport​(Configuration configuration,
                             java.lang.String reportType,
                             JSONObject reportDescription)
                      throws SitecatalystException
        Deprecated.
        Analytics API 1.4 no longer requires a report type as parameter for queueing reports. Use queueReport(Configuration, JSONObject) instead.
        Queues a report of type reportType with the reportDescription.
        Parameters:
        configuration - Web service support configuration
        reportType - The type of report to queue
        reportDescription - The reportDescription JSON to use
        Returns:
        report of type reportType
        Throws:
        SitecatalystException - SitecatalystException
        Since:
        5.6

      • queueReport

        java.lang.String queueReport​(Configuration configuration,
                             JSONObject reportDescription)
                      throws SitecatalystException
        Queues the execution of an Analytics report based on a given JSON reportDescription.
        Parameters:
        configuration - Web service support configuration
        reportDescription - a reportDescription JSON object that specifies the desired report contents
        Returns:
        a stringified JSON containing the ID of the queued report
        Throws:
        SitecatalystException - SitecatalystException
        Since:
        5.13.0

      • queuePageViewReport

        java.lang.String queuePageViewReport​(Configuration configuration,
                                     java.lang.String rsid,
                                     java.lang.String date)
                              throws SitecatalystException
        Queues a report of type pageView for a report suite rsid and the report date date
        Parameters:
        configuration - Web service support configuration
        rsid - Report suite ID
        date - Date
        Returns:
        report of type pageView
        Throws:
        SitecatalystException - SitecatalystException

      • getSynchronousReport

        @Deprecated
java.lang.String getSynchronousReport​(Configuration configuration,
                                      java.lang.String reportType,
                                      JSONObject reportDescription)
                               throws SitecatalystException
        Deprecated.
        The Analytics API no longer supports synchronous reports starting with the 1.4 version.
        Returns a report of type reportType and report description reportDescription.
        Parameters:
        configuration - Web service support configuration
        reportType - the type of report to queue
        reportDescription - the reportDescription json to use
        Returns:
        report of type reportType and report description reportDescription
        Throws:
        SitecatalystException - SitecatalystException
        Since:
        5.6

      • getMetrics

        java.lang.String getMetrics​(Configuration configuration,
                            java.lang.String rsID)
                     throws SitecatalystException
        Retrieves a list of possible valid elements for a report. Some accounts may not have access to certain metrics. The metrics returned by GetMetrics reflect those restrictions. See more information on this API method at https://experiencecloud.adobe.com/developer/en_US/documentation/analytics-reporting-1-4/r-getmetrics
        Parameters:
        configuration - Web service support configuration
        rsID - The reporting suite id
        Returns:
        response String
        Throws:
        SitecatalystException - SitecatalystException

      • getSuccessEvents

        java.lang.String getSuccessEvents​(Configuration configuration,
                                  java.lang.String rsid)
                           throws SitecatalystException
        Returns a JSON representation of success events (event's) for the report suite rsid.
        Parameters:
        configuration - Web service support configuration
        rsid - Report suite ID
        Returns:
        JSON representation of success events for rside
        Throws:
        SitecatalystException - SitecatalystException

      • getPages

        @Deprecated
java.lang.String getPages​(Configuration configuration,
                          java.lang.Integer limit,
                          java.lang.String pagename,
                          java.lang.String rsid,
                          java.lang.Integer start)
                   throws SitecatalystException
        Deprecated.
        The Analytics API no longer supports retrieving a list of pages from specified report suite starting with the 1.4 version.
        Returns a JSON representation of pages matching the page name pagename for the report suite rsid.
        Parameters:
        configuration - Web service support configuration
        limit - Max. number of pages
        pagename - Name of the page
        rsid - Report Suite ID
        start - Start point for paging
        Returns:
        list of pages for rsid
        Throws:
        SitecatalystException - SitecatalystException

      • getClassifications

        @Deprecated
JSONArray getClassifications​(Configuration configuration,
                             java.lang.String classificationView,
                             java.lang.String[] reportSuites,
                             int relationId)
                      throws SitecatalystException
        Deprecated.
        This method was used to support SAINT which is now deprecated.
        Retrieves a list of classifications (associated with the specified element) for each of the specified reportSuites.
        Parameters:
        configuration - Web service support configuration
        classificationView - The ID of the element whose classifications are being retrieved. The possible type IDs include the following elements.
        • campaign Classification applied to the Campaign report.
        • days_between_buys Classification applied to the Days Between Buys report.
        • days_till_purchase Classification applied to the Days Until Purchase report.
        • domain Classification applied to the Domain report.
        • evar1-75 Classification applied to the specified eVar report (evar1, evar2, etc.)
        • first_touch_marketing_channel Classification applied to the First Touch Marketing Channel report.
        • first_touch_marketing_channel_detail Classification applied to the detailed First Touch Marketing Channel report.
        • last_touch_marketing_channel Classification applied to the Last Touch Marketing Channel report.
        • last_touch_marketing_channel_detail Classification applied to the detailed Last Touch Marketing Channel report.
        • loyalty Classification applied to the Loyalty report.
        • media Classification applied to the Media report.
        • page Classification applied to the Page report.
        • page_type1-77 Classification applied to a specific Page Type report.
        • page_type1 Site Sections
        • page_type2 Servers
        • page_type3-77 Custom Insight (Props) 1 - 75.
        • mvvar45-47 Classification applied to a List Var report, mvvar45 - mvvar47 = listvar1 - listvar3.
        • product Classification applied to the Product report.
        • sitetime Classification applied to the Site Time report.
        • state Classification applied to the State report.
        • survey Classification applied to the Survey report.
        • tnt Classification applied to the Adobe Target report.
        • visitdepth Classification applied to the Visit Depth report.
        • visitnum Classification applied to the VisitNum report.
        • zipcode Classification applied to the Zip Code report.
        reportSuites - A list of report suite IDs.
        relationId - (Optional) Numeric ID of the variable for which you want to retrieve associated classifications or -1.
        Returns:
        A JSONArray of JSONObjects containing information about a report suite's classifications.The objects are of the following structure:

        {
          rsid: (int),
          site_title: (string),
          classifications: [{
            classifications: [{
              child_nodes: [{
                rel_id: (int),
                userid: (int),
                div_name: (string),
                div_num: (int),
                parent_div_num: (int),
                campaign_view_flag: (int),
                type: (int),
                order: (int),
                child_nodes: (array)
              }],
              div_name: (string),
              div_num: (int),
              rel_id: (int)
            }],
            in_queue: (int),
            status: (int)
         }]
        }

        Throws:
        SitecatalystException - SitecatalystException
        Since:
        5.7

      • saveClassifications

        @Deprecated
boolean saveClassifications​(Configuration configuration,
                            java.lang.String classificationView,
                            boolean campaignView,
                            java.lang.String name,
                            int parentDivNum,
                            java.lang.String[] reportSuites,
                            boolean update)
                     throws SitecatalystException
        Deprecated.
        This method was used to support SAINT which is now deprecated.
        Saves a classification for each of the specified reportSuites.
        Parameters:
        configuration - Web service support configuration
        classificationView - The ID of the element whose classifications are being retrieved. The possible type IDs include the following elements.
        • campaign Classification applied to the Campaign report.
        • days_between_buys Classification applied to the Days Between Buys report.
        • days_till_purchase Classification applied to the Days Until Purchase report.
        • domain Classification applied to the Domain report.
        • evar1-75 Classification applied to the specified eVar report (evar1, evar2, etc.)
        • first_touch_marketing_channel Classification applied to the First Touch Marketing Channel report.
        • first_touch_marketing_channel_detail Classification applied to the detailed First Touch Marketing Channel report.
        • last_touch_marketing_channel Classification applied to the Last Touch Marketing Channel report.
        • last_touch_marketing_channel_detail Classification applied to the detailed Last Touch Marketing Channel report.
        • loyalty Classification applied to the Loyalty report.
        • media Classification applied to the Media report.
        • page Classification applied to the Page report.
        • page_type1-77 Classification applied to a specific Page Type report.
        • page_type1 Site Sections
        • page_type2 Servers
        • page_type3-77 Custom Insight (Props) 1 - 75.
        • mvvar45-47 Classification applied to a List Var report, mvvar45 - mvvar47 = listvar1 - listvar3.
        • product Classification applied to the Product report.
        • sitetime Classification applied to the Site Time report.
        • state Classification applied to the State report.
        • survey Classification applied to the Survey report.
        • tnt Classification applied to the Adobe Target report.
        • visitdepth Classification applied to the Visit Depth report.
        • visitnum Classification applied to the VisitNum report.
        • zipcode Classification applied to the Zip Code report.
        campaignView - Determines whether to treat this classification like a campaign.
        name - Visible name of the classification.
        parentDivNum - Contains the parent classification's div_num if this is a sub-classification; otherwise it is 0.
        reportSuites - A list of report suite IDs.
        update - Enables the classification when set to true, disabled it otherwise.
        Returns:
        Returns true if the update operation is successful, false otherwise
        Throws:
        SitecatalystException - SitecatalystException
        Since:
        5.7

      • deleteClassifications

        @Deprecated
boolean deleteClassifications​(Configuration configuration,
                              java.lang.String classificationView,
                              java.lang.String[] reportSuites,
                              int divNum,
                              int parentDivNum)
                       throws SitecatalystException
        Deprecated.
        This method was used to support SAINT which is now deprecated.
        Deletes a classification from one or more reportSuites.
        Parameters:
        configuration - Web service support configuration
        classificationView - The ID of the element whose classifications are being retrieved. The possible type IDs include the following elements.
        • campaign Classification applied to the Campaign report.
        • days_between_buys Classification applied to the Days Between Buys report.
        • days_till_purchase Classification applied to the Days Until Purchase report.
        • domain Classification applied to the Domain report.
        • evar1-75 Classification applied to the specified eVar report (evar1, evar2, etc.)
        • first_touch_marketing_channel Classification applied to the First Touch Marketing Channel report.
        • first_touch_marketing_channel_detail Classification applied to the detailed First Touch Marketing Channel report.
        • last_touch_marketing_channel Classification applied to the Last Touch Marketing Channel report.
        • last_touch_marketing_channel_detail Classification applied to the detailed Last Touch Marketing Channel report.
        • loyalty Classification applied to the Loyalty report.
        • media Classification applied to the Media report.
        • page Classification applied to the Page report.
        • page_type1-77 Classification applied to a specific Page Type report.
        • page_type1 Site Sections
        • page_type2 Servers
        • page_type3-77 Custom Insight (Props) 1 - 75.
        • mvvar45-47 Classification applied to a List Var report, mvvar45 - mvvar47 = listvar1 - listvar3.
        • product Classification applied to the Product report.
        • sitetime Classification applied to the Site Time report.
        • state Classification applied to the State report.
        • survey Classification applied to the Survey report.
        • tnt Classification applied to the Adobe Target report.
        • visitdepth Classification applied to the Visit Depth report.
        • visitnum Classification applied to the VisitNum report.
        • zipcode Classification applied to the Zip Code report.
        reportSuites - A list of report suite IDs.
        divNum - The numeric index of the classification in its group, which can be obtained from getClassifications(Configuration, String, String[], int)
        parentDivNum - Contains the parent classification's div_num if this is a sub-classification; otherwise it is 0.
        Returns:
        Returns true if the deletion operation is successful, false otherwise.
        Throws:
        SitecatalystException - SitecatalystException
        Since:
        5.7