Package com.day.cq.analytics.sitecatalyst

Interface SitecatalystWebservice

    • Method Detail

      • checkCredentials

        @Deprecated
void checkCredentials​(String company,
                      String username,
                      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.

      • getSegments

        String getSegments​(String server,
                   String company,
                   String username,
                   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

      • queueReport

        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

      • getSynchronousReport

        @Deprecated
String getSynchronousReport​(Configuration configuration,
                            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

        String getMetrics​(Configuration configuration,
                  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

      • getPages

        @Deprecated
String getPages​(Configuration configuration,
                Integer limit,
                String pagename,
                String rsid,
                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,
                             String classificationView,
                             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,
                            String classificationView,
                            boolean campaignView,
                            String name,
                            int parentDivNum,
                            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,
                              String classificationView,
                              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