API Documentation

Jump to bottom

jamesmirvine edited this page Aug 21, 2014 · 1 revision

The pages provides documentation on all methods provided by this package.

<a name="top"href="#wiki-top">•Index

↑ Back to Top ↑

•Introduction

As previously mentioned, this package was designed based on the Laravel DB Query class. This choice was made due to the fact that the StatCounter API is simply exposing access to their databases.

When utilizing this package to make queries, you will be returned the data array given by the StatCounter API. For more specific information on what is returned for each query, please read the StatCounter API Documentation.

Also note, API errors will throw a StatException with the their error message.

↑ Back to Top ↑

Stat Methods

•Tracker Method

Description:

Displays the StatCounter tracker for the project.

Usage:

echo Stat::tracker();

Parameter(s):

isHttps [boolean][optional] - Whether or not to use the https scheme. Default is false.
isVisible [boolean][optional] - Whether or not to use a visible tracker. Default is false.
websiteTitle [string][optional] - Only necessary if specifying projects other than the default given in the config. Must match one of the project alias names.

Return:

String - The standard tracker code as shown below.

<script type="text/javascript">
var sc_project=0123456;
var sc_invisible=0;
var sc_security="abcd0123";
var sc_https=0;
var scJsHost = (("https:" == document.location.protocol) ?
"https://secure." : "http://www.");
document.write("<sc"+"ript type=\'text/javascript\' src=\'" +
scJsHost+
"statcounter.com/counter/counter.js\'></"+"script>");
</script>
<noscript><div class="statcounter"><a title="hits counter"
href="http://statcounter.com/" target="_blank"><img
class="statcounter"
src="http://c.statcounter.com/0123456/0/abcd0123/0/"
alt="hits counter"></a></div></noscript>

↑ Back to Top ↑

•Summary Method

Description:

Starts a 'summary' query. See http://api.statcounter.com/docs/v3#summary.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::summary()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Recent Visitors Method

Description:

Starts a 'recent visitor' query. See http://api.statcounter.com/docs/v3#visitors.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::recentVisitors()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Popular Pages Method

Description:

Starts a 'popular pages' query. See http://api.statcounter.com/docs/v3#popular.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::popularPages()->get();

Parameter(s):

chopUrl [boolean][optional] - Chop the query string from the returned URL. Many URLs contain data variables in a query string that is used to set details on the web page. Chopping the query string can make the returned URL list easier to read and less cluttered. Default is true.
countType [boolean][optional] - The type of counts used by a stat. Default value is COUNT_TYPE_PAGE_VIEW. The available options are:
- COUNT_TYPE_PAGE_VIEW [const] - Stats are counted by page views
- COUNT_TYPE_VISITOR [const] - Stats are counted by visitors

Return:

$this

↑ Back to Top ↑

•Entry Pages Method

Description:

Starts a 'entry pages' query. See http://api.statcounter.com/docs/v3#entry.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::entryPages()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Exit Pages Method

Description:

Starts a 'exit pages' query. See http://api.statcounter.com/docs/v3#exit.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::exitPages()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Came From Method

Description:

Starts a 'came from' query. See http://api.statcounter.com/docs/v3#camefrom.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::cameFrom()->get();

Parameter(s):

external [boolean][optional] - Choose to exclude external results to your site. Default is true.
excludeSearchEngines [boolean][optional] - Choose to exclude search engine driven results to your site. Default is false.
groupByDomain [boolean][optional] - Choose to group results by referring domain. Default is false.

Return:

$this

↑ Back to Top ↑

•Recent Keywords Method

Description:

Starts a 'recent keywords' query. See http://api.statcounter.com/docs/v3#keyword-activity.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::recentKeywords()->get();

Parameter(s):

excludeEncryptedKeywords [boolean][optional] - Choose to exclude encrypted keyword results. Default is false.
external [boolean][optional] - Choose to exclude external results to your site. Default is true.

Return:

$this

↑ Back to Top ↑

•Browsers Method

Description:

Starts a 'browsers' query. See http://api.statcounter.com/docs/v3#browsers.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::browsers()->get();

Parameter(s):

device [integer][optional] - Choose the device type. Default value is DEVICE_All. The available options are:
- DEVICE_All [const] - All devices
- DEVICE_DESKTOP [const] - Only desktop devices
- DEVICE_MOBILE [const] - Only mobile devices

Return:

$this

↑ Back to Top ↑

•Operating Systems Method

Description:

Starts a 'operating systems' query. See http://api.statcounter.com/docs/v3#os.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::operatingSystems()->get();

Parameter(s):

device [integer][optional] - Choose the device type. Default value is DEVICE_All. The available options are:
- DEVICE_All [const] - All devices
- DEVICE_DESKTOP [const] - Only desktop devices
- DEVICE_MOBILE [const] - Only mobile devices

Return:

$this

↑ Back to Top ↑

•Search Engines Method

Description:

Starts a 'search engines' query. See http://api.statcounter.com/docs/v3#search_engine.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::searchEngines()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Country Method

Description:

Starts a 'country' query. See http://api.statcounter.com/docs/v3#country.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::country()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Recent Pageload Method

Description:

Starts a 'recent pageload' query. See http://api.statcounter.com/docs/v3#pageload.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::recentPageload()->get();

Parameter(s):

device [integer][optional] - Choose the device type. Default value is DEVICE_All. The available options are:
- DEVICE_All [const] - All devices
- DEVICE_DESKTOP [const] - Only desktop devices
- DEVICE_MOBILE [const] - Only mobile devices

Return:

$this

↑ Back to Top ↑

•Exit Link Method

Description:

Starts a 'exit link' query. See http://api.statcounter.com/docs/v3#exit-link-activity.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::exitLink()->get();

Parameter(s):

device [integer][optional] - Choose the device type. Default value is DEVICE_All. The available options are:
- DEVICE_All [const] - All devices
- DEVICE_DESKTOP [const] - Only desktop devices
- DEVICE_MOBILE [const] - Only mobile devices

Return:

$this

↑ Back to Top ↑

•Download Link Method

Description:

Starts a 'download link' query. See http://api.statcounter.com/docs/v3#download-link-activity.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::downloadLink()->get();

Parameter(s):

device [integer][optional] - Choose the device type. Default value is DEVICE_All. The available options are:
- DEVICE_All [const] - All devices
- DEVICE_DESKTOP [const] - Only desktop devices
- DEVICE_MOBILE [const] - Only mobile devices

Return:

$this

↑ Back to Top ↑

•Visit Length Method

Description:

Starts a 'visit length' query. See http://api.statcounter.com/docs/v3#visit-length.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::visitLength()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Returning Visits Method

Description:

Starts a 'returning visits' query. See http://api.statcounter.com/docs/v3#returning-visits.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::returningVisits()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Keyword Analysis Method

Description:

Starts a 'keyword analysis' query. See http://api.statcounter.com/docs/v3#keyword-analysis.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::keywordAnalysis()->get();

Parameter(s):

combineKeywords* [integer][optional] - Choose to combine keyword results based on one of three possible criteria. Default value is SEARCH_ENGINE_HOST`. The available options are:
- SEARCH_ENGINE_HOST [const] - Groups results by common search engine host values
- SEARCH_ENGINE_NAME [const] - Groups results by common search engine names
- SEARCH_ENGINE_TOGETHER [const] - Groups results by common keyword values
excludeEncryptedKeywords [boolean][optional] - Choose to exclude encrypted keyword results. Default is false.

Return:

$this

↑ Back to Top ↑

•Lookup Visitor Method

Description:

Starts a 'lookup visitor' query. See http://api.statcounter.com/docs/v3#lookup-visitor.

Note: This doesn't actually submit the query. You must use the Get Method to submit stat type queries.

Usage:

$stats = Stat::lookupVisitor('127.0.0.1')->get();

Parameter(s):

ipAddress [string] - The I.P. address of a visitor you want to look up.

Return:

$this

↑ Back to Top ↑

Stat Utility Methods

•Set Range Method

Description:

Optional method. Sets the range of the selected Stat Query. See http://api.statcounter.com/docs/v3#date-range.

Usage:

$stats = Stat::popularPages()->setRange(\Injic\LaravelStatcounter\Stat::GRAN_WEEKLY, new Carbon('first day of January 2008', 'America/Vancouver'), new Carbon())->get();

Parameter(s):

granularity [string] - The time interval of returned stats. Default value is GRAN_WEEKLY. The available options are:
- GRAN_HOURLY [const] - Hourly interval granularity in results
- GRAN_DAILY [const] - Daily interval granularity in results
- GRAN_WEEKLY [const] - Weelly interval granularity in results
- GRAN_MONTHLY [const] - Monthly interval granularity in results
- GRAN_QUARTERLY [const] - Quarterly interval granularity in results
- GRAN_YEARLY [const] - Yearly interval granularity in results
start [integer|string|Carbon] - The starting date for the range. Accepts an integer timestamps, a string with PHP Supported Date and Time Formats, a DateTimeZone instance, or a Carbon instance. The default is the first day of the year.
end [integer|string|Carbon] - The ending date for the range. Accepts same as start. The default is the last day of the year.

Return:

$this

↑ Back to Top ↑

•Project Method

Description:

Optional method. Sets the project(s) of the selected Query. See http://api.statcounter.com/docs/v3#batch.

Usage:

$stats = Stat::project('Example Website')->lookupVisitor('127.0.0.1')->get();

Parameter(s):

websiteTitle [string] - The name of the project alias in the config e.g. 'My Website'.

Return:

$this

↑ Back to Top ↑

•Set Username Method

Description:

Optional method. Sets the username of the selected Query.

Usage:

$stats = Stat::project('Example Website')->setUsername('SOme UsEr')->get();

Parameter(s):

username [string] - Your StatCounter username.

Return:

$this

↑ Back to Top ↑

•Set Password Method

Description:

Optional method. Sets the password of the selected Query.

Usage:

$stats = Stat::project('Example Website')->setUsername('SOme UsEr')->setPassword('some_Passw0rd')->get();

Parameter(s):

password [string] - Your StatCounter API password.

Return:

$this

↑ Back to Top ↑

•Number Of Results Method

Description:

Optional method. Sets the number of results to be returned with the query. The default is 1000.

Note: StatCounter's default is 20, it is overridden by default with 1000. Some queries will provide all results when -1 is passed, while others return a MySQL error.

Usage:

$stats = Stat::recentVisitors()->numberOfResults(10)->get();

Parameter(s):

num [integer] - The number of results to be returned with the query.

Return:

$this

↑ Back to Top ↑

Project Administration Methods

•Add Project Method

Description:

Starts a 'add project' query. See http://api.statcounter.com/docs/v3#create-project.

Usage:

$project = Stat::addProject('Example Website','example.com','America/Chicago');

Parameter(s):

websiteTitle [string] - The name that will be given to the new StatCounter project e.g. 'My Website'.
websiteUrl [string] - The URL of the website e.g. 'http://www.mywebsite.com/'.
timezone [string] - The time zone to be used for the project stats e.g. 'America/New_York'. See Time Zone Options for the complete list. The default is 'America/New_York'.
publicStats [integer][optional] - Set the level of public access to stats in a project. Default value is PUBLIC_STATS_NONE. The available options are:
- PUBLIC_STATS_NONE [const] - All stats are private
- PUBLIC_STATS_ALL [const] - All stats are public
- PUBLIC_STATS_SUMMARY [const] - Only summary stats are public

Return:

Array

↑ Back to Top ↑

•Update Project Method

Description:

Starts a 'update project' query. See http://api.statcounter.com/docs/v3#update-project.

Usage:

$project = Stat::updateProject('Example Website',\Injic\LaravelStatcounter\Stat::PUBLIC_STATS_NONE);

Parameter(s):

websiteTitle [string][optional] - The name of the project alias in the config e.g. 'My Website'. Default value is config-defined default project.
publicStats [integer][optional] - Set the level of public access to stats in a project. Default value is PUBLIC_STATS_NONE. The available options are:
- PUBLIC_STATS_NONE [const] - All stats are private
- PUBLIC_STATS_ALL [const] - All stats are public
- PUBLIC_STATS_SUMMARY [const] - Only summary stats are public

Return:

Array

↑ Back to Top ↑

•Update Logsize Method

Description:

Starts a 'update logsize' query. See http://api.statcounter.com/docs/v3#increase-logsize.

Usage:

$project = Stat::updateLogsize('Example Website');

Parameter(s):

websiteTitle [string][optional] - The name of the project alias in the config e.g. 'My Website'. Default value is config-defined default project.

Return:

Array

↑ Back to Top ↑

•Account Logsizes Method

Description:

Starts a 'account logsizes' query. See http://api.statcounter.com/docs/v3#retrieve-logsizes.

Usage:

$project = Stat::userDetails();

Parameter(s):

None

Return:

Array

↑ Back to Top ↑

•User Details Method

Description:

Starts a 'user details' query. See http://api.statcounter.com/docs/v3#user-details.

Usage:

$project = Stat::userDetails();

Parameter(s):

username [string][optional] - Your StatCounter username. Default value is config-defined username.
password [string][optional] - Your StatCounter API password. Default value is config-defined API password.

Return:

Array

↑ Back to Top ↑

•User Projects Method

Description:

Starts a 'user projects' query. See http://api.statcounter.com/docs/v3#user-projects.

Usage:

$project = Stat::userProjects();

Parameter(s):

username [string][optional] - Your StatCounter username. Default value is config-defined username.
password [string][optional] - Your StatCounter API password. Default value is config-defined API password.

Return:

Array

↑ Back to Top ↑

•Select Project Method

Description:

Starts a 'select project' query. See http://api.statcounter.com/docs/v3#select-project.

Usage:

$project = Stat::selectProject();

Parameter(s):

websiteTitle [string][optional] - The name of the project alias in the config e.g. 'My Website'. Default value is config-defined default project.

Return:

Array

↑ Back to Top ↑

Laravel DB Style Methods

•Offset Method

Description:

Set the "offset" value of the query.

Usage:

$stats = Stat::recentVisitors()->offset(5)->get();

Parameter(s):

value [integer]

Return:

$this

↑ Back to Top ↑

•Skip Method

Description:

Alias to set the "offset" value of the query.

Usage:

$stats = Stat::recentVisitors()->skip(5)->get();

Parameter(s):

value [integer]

Return:

$this

↑ Back to Top ↑

•Limit Method

Description:

Set the "limit" value of the query. Different from the Number Of Results Method because it handles the results after receiving them in order to paginate.

Note: StatCounter would need to expose offsetting in their API in order to handle pagination on the database side.

Usage:

$stats = Stat::recentVisitors()->limit(10)->get();

Parameter(s):

value [integer]

Return:

$this

↑ Back to Top ↑

•Take Method

Description:

Alias to set the "limit" value of the query.

Usage:

$stats = Stat::recentVisitors()->take(5)->get();

Parameter(s):

value [integer]

Return:

$this

↑ Back to Top ↑

•For Page Method

Description:

Set the limit and offset for a given page.

Usage:

$stats = Stat::recentVisitors()->forPage(2)->get();

Parameter(s):

page [integer]
perPage [integer]

Return:

$this

↑ Back to Top ↑

•Chunk Method

Description:

Chunk the results of the query.

Usage:

$stats = Stat::recentVisitors()->chunk(15, function(){
  ...
});

Parameter(s):

count [integer]
callback [callable]

Return:

void

↑ Back to Top ↑

•To URL Method

Description:

Compiles a StatCounter API query URL based on the given query paramters.

Usage:

$url = Stat::recentVisitors()->skip(5)->toUrl();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Remember Method

Description:

Indicate that the query results should be cached.

Usage:

$stats = Stat::recentVisitors()->skip(5)->remember(15)->get();

Parameter(s):

minutes [integer]

Return:

$this

↑ Back to Top ↑

•Remember Forever Method

Description:

Indicate that the query results should be cached forever.

Usage:

$stats = Stat::recentVisitors()->skip(5)->rememberForever()->get();

Parameter(s):

None

Return:

$this

↑ Back to Top ↑

•Cache Tags Method

Description:

Indicate that the results, if cached, should use the given cache tags.

Usage:

$stats = Stat::recentVisitors()->take(5)->cacheTags('stats')->remember(15)->get();

Parameter(s):

cacheTags [array|dynamic]

Return:

$this

↑ Back to Top ↑

•Cache Driver Method

Description:

Indicate that the results, if cached, should use the given cache driver.

Usage:

$stats = Stat::recentVisitors()->take(5)->cacheDriver('redis')->remember(15)->get();

Parameter(s):

cacheTags [string]

Return:

$this

↑ Back to Top ↑

•Pluck Method

Description:

Pluck a single column's value from the first result of a query.

Usage:

$stats = Stat::recentVisitors()->pluck('os');

Parameter(s):

column [string]

Return:

mixed

↑ Back to Top ↑

•First Method

Description:

Execute the query and get the first result.

Usage:

$stats = Stat::recentVisitors()->first();

Parameter(s):

columns [array]

Return:

mixed

↑ Back to Top ↑

•Get Method

Description:

Execute the query and get the result(s).

Usage:

$stats = Stat::recentVisitors()->get();

Parameter(s):

columns [array]

Return:

mixed

↑ Back to Top ↑

•Get Fresh Method

Description:

Execute the query as a fresh call to the API.

Usage:

$stats = Stat::recentVisitors()->getFresh();

Parameter(s):

columns [array]

Return:

mixed

↑ Back to Top ↑

•Get Cached Method

Description:

Execute the query as a cached call to the API.

Usage:

$stats = Stat::recentVisitors()->getCached();

Parameter(s):

columns [array]

Return:

mixed

↑ Back to Top ↑

•Get Cache Key Method

Description:

Get a unique cache key for the complete query.

Usage:

$stats = Stat::recentVisitors()->getCacheKey();

Parameter(s):

None

Return:

string

↑ Back to Top ↑

•Generate Cache Key Method

Description:

Generate the unique cache key for the query.

Usage:

$stats = Stat::recentVisitors()->generateCacheKey();

Parameter(s):

None

Return:

string

↑ Back to Top ↑

•Generate Cache Key Method

Description:

Generate the unique cache key for the query.

Usage:

$stats = Stat::recentVisitors()->generateCacheKey();

Parameter(s):

None

Return:

string

↑ Back to Top ↑

•Paginate Method

Description:

Get a paginator for the query.

Usage:

$stats = Stat::recentVisitors()->paginate();

Parameter(s):

perPage [integer]
columns [array]

Return:

\Illuminate\Pagination\Paginator

↑ Back to Top ↑

•Get Pagination Count Method

Description:

Get the count of the total records for pagination.

Usage:

$stats = Stat::recentVisitors()->paginate();

Parameter(s):

None

Return:

integer

↑ Back to Top ↑

•Simple Paginate Method

Description:

Get a paginator only supporting simple next and previous links.

This is more efficient on larger data-sets, etc.

Usage:

$stats = Stat::recentVisitors()->simplePaginate();

Parameter(s):

perPage [integer]
columns [array]

Return:

\Illuminate\Pagination\Paginator

↑ Back to Top ↑

•Exists Method

Description:

Determine if any rows exist for the current query.

Usage:

$stats = Stat::recentVisitors()->exists();

Parameter(s):

None

Return:

bool

↑ Back to Top ↑

•Count Method

Description:

Retrieve the "count" result of the query.

Usage:

$stats = Stat::recentVisitors()->count();

Parameter(s):

columns [array]

Return:

integer

↑ Back to Top ↑

•New Query Method

Description:

Get a new instance of the stat query.

Usage:

$statObj = Stat::recentVisitors();
...
$stats = $statObj->get();
...
$newStatObj = $statObj->newQuery();

Parameter(s):

columns [array]

Return:

\Injic\LaravelStatcounter\Stat

↑ Back to Top ↑

•Raw Method

Description:

Create a raw query to the API. Accepts full url string, query portion of the url, or an array of parameters. Defaults to config defaults and the parameter defaults mentioned in their modifying methods.

Usage:

$stats = Stat::raw('https://api.statcounter.com/stats?vn=3&s=keyword_analysis&pi=9917949&u=DaFlyinJ&t=1408580636')->get();

// - OR -

$stats = Stat::raw(['s' => 'keyword_analysis'])->get();

Parameter(s):

value [mixed]

Return:

$this

↑ Back to Top ↑

•Columns Method

Description:

Reads query results for columns.

Usage:

$columns = Stat::recentVisitors()->columns();

Parameter(s):

None

Return:

array

↑ Back to Top ↑

•Get Columns Method

Description:

Reads array for column values.

Usage:

$stats = Stat::recentVisitors()->get();

$columns = Stat::getColumns($stats);

Parameter(s):

array [array]

Return:

array

↑ Back to Top ↑