The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Business-SiteCatalyst-1.2.2
River stage zero No dependents
1 ++
/ Business::SiteCatalyst::Company

NAME

Business::SiteCatalyst::Company - Interface to Adobe Omniture SiteCatalyst's REST API 'Company' module.

VERSION

Version 1.2.2

SYNOPSIS

This module allows you to interact with Adobe (formerly Omniture) SiteCatalyst, a web analytics service. It encapsulates all the communications with the API provided by Adobe SiteCatalyst to offer a Perl interface for managing reports, pulling company-specific SiteCatalyst data (ex: token usage), uploading SAINT data (feature not implemented yet), etc.

Please note that you will need to have purchased the Adobe SiteCatalyst product, and have web services enabled within your account first in order to obtain a web services shared secret, as well as agree with the Terms and Conditions for using the API.

See SiteCatalyst API Explorer at https://developer.omniture.com/en_US/get-started/api-explorer for 'Company' module documentation

        use Business::SiteCatalyst;
        
        # Create an object to communicate with Adobe SiteCatalyst
        my $site_catalyst = Business::SiteCatalyst->new(
                username        => 'dummyusername',
                shared_secret   => 'dummysecret',
                api_subdomain   => 'api|api2', #optional; default value='api'
        );
        
        my $company = $site_catalyst->instantiate_company();
        
        my $token_data = $company->get_token_usage();
        
        my $tokens_left = $company->get_token_count();
        
        my $report_suites = $company->get_report_suites();
        
        my $tracking_server = $company->get_tracking_server();
        
        my $endpoint = $company->get_endpoint( company => $company );
        
        my $queue_list = $company->get_queue();
        
        my $success = $company->cancel_queue_item( queue_id => $queue_item_id );
        
        my $version_list = $company->get_version_access();

METHODS

new()

Create a new Business::SiteCatalyst::Company object, which will allow retrieval of SiteCatalyst company-specific info.

NOTE: -This should not be called directly-. Instead, use Business::SiteCatalyst-instantiate_company()>.

        my $company = Business::SiteCatalyst::Company->new(
                $site_catalyst,
        );

Parameters: none

get_token_count()

Determine the number of tokens left for your company. You are alloted 10,000 tokens per month.

        my $tokens_left = $company->get_token_count();

get_token_usage()

Information about the company's token usage for the current calendar month, broken down by user account.

        my $token_data = $company->get_token_usage();

get_site_catalyst()

Get Business::SiteCatalyst object used when creating the current object.

        my $site_catalyst = $report->get_site_catalyst();

get_report_suites()

Information about the company's report suites configured in SiteCatalyst.

        my $report_suites = $company->get_report_suites();

get_tracking_server()

Returns the tracking server and namespace for the specified report suite. If report suite is not specified, 'report_suite_id' in SiteCatalystConfig (if one exists) will be used.

        my $tracking_server = $company->get_tracking_server();
        my $tracking_server = $company->get_tracking_server( 
                report_suite_id => $report_suite_id 
        );

Optional parameters:

  • report_suite_id

    The Report Suite ID you want to pull data from.

get_endpoint()

Retrieves the endpoint (API URL) for the specified company. NOTE: You can specify any company, not just your own.

        my $endpoint = $company->get_endpoint( company => $company );

Parameters:

  • company

    The company whose endpoint you want to retrieve.

get_queue()

Returns queued items that are pending approval for the requesting company.

        my $queue_list = $company->get_queue();

cancel_queue_item()

Cancel a pending (queued) action that has yet to be approved.

        my $success = $company->cancel_queue_item( queue_id => $queue_item_id );

Parameters:

  • queue_id

    The numeric identifier of the pending item you wish to cancel.

get_version_access()

Information about the version of various Adobe services you have access to.

        my $version_list = $company->get_version_access();

AUTHOR

Jennifer Pinkham, <jpinkham at cpan.org>.

BUGS

Please report any bugs or feature requests to bug-Business-SiteCatalyst at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Business-SiteCatalyst. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc Business::SiteCatalyst::Company

You can also look for information at:

ACKNOWLEDGEMENTS

Thanks to ThinkGeek (http://www.thinkgeek.com/) and its corporate overlords at Geeknet (http://www.geek.net/), for footing the bill while I write code for them! Special thanks for technical help from fellow ThinkGeek CPAN author Guillaume Aubert http://search.cpan.org/~aubertg/

COPYRIGHT & LICENSE

Copyright 2013 Jennifer Pinkham.

This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License.

See http://dev.perl.org/licenses/ for more information.