com.flickr4java.flickr.stats

Class StatsInterface

java.lang.Object

com.flickr4java.flickr.stats.StatsInterface

public class StatsInterface
extends java.lang.Object

Interface to the Stats API.

Constructor Summary

Constructors

Constructor and Description
StatsInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI)

Method Summary

Methods

Modifier and Type	Method and Description
DomainList	getCollectionDomains(java.util.Date date, java.lang.String collectionId, int perPage, int page) Get a list of referring domains for a collection.
ReferrerList	getCollectionReferrers(java.util.Date date, java.lang.String domain, java.lang.String collectionId, int perPage, int page) Get a list of referrers from a given domain to a collection.
Stats	getCollectionStats(java.lang.String collectionId, java.util.Date date) Get the number of views, comments and favorites on a collection for a given date.
java.util.List<Csv>	getCSVFiles() Returns a list of URLs for text files containing all your stats data (from November 26th 2007 onwards) for the currently auth'd user.
DomainList	getPhotoDomains(java.util.Date date, java.lang.String photoId, int perPage, int page) Get a list of referring domains for a photo.
ReferrerList	getPhotoReferrers(java.util.Date date, java.lang.String domain, java.lang.String photoId, int perPage, int page) Get a list of referrers from a given domain to a photo.
DomainList	getPhotosetDomains(java.util.Date date, java.lang.String photosetId, int perPage, int page) Get a list of referring domains for a photoset.
ReferrerList	getPhotosetReferrers(java.util.Date date, java.lang.String domain, java.lang.String photosetId, int perPage, int page) Get a list of referrers from a given domain to a photoset.
Stats	getPhotosetStats(java.lang.String photosetId, java.util.Date date) Get the number of views, comments and favorites on a photoset for a given date.
Stats	getPhotoStats(java.lang.String photoId, java.util.Date date) Get the number of views, comments and favorites on a photo for a given date.
DomainList	getPhotostreamDomains(java.util.Date date, int perPage, int page) Get a list of referring domains for a photostream.
ReferrerList	getPhotostreamReferrers(java.util.Date date, java.lang.String domain, int perPage, int page) Get a list of referrers from a given domain to a user's photostream.
Stats	getPhotostreamStats(java.util.Date date) Get the number of views, comments and favorites on a photostream for a given date.
PhotoList<Photo>	getPopularPhotos(java.util.Date date, StatsSort sort, int perPage, int page) List the photos with the most views, comments or favorites.
Totals	getTotalViews(java.util.Date date) Get the overall view counts for an account

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatsInterface

public StatsInterface(java.lang.String apiKey,
              java.lang.String sharedSecret,
              Transport transportAPI)

Method Detail

getCollectionDomains

public DomainList getCollectionDomains(java.util.Date date,
                              java.lang.String collectionId,
                              int perPage,
                              int page)
                                throws FlickrException

Get a list of referring domains for a collection.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

collectionId - (Optional) The id of the collection to get stats for. If not provided, stats for all collections will be returned.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getCollectionDomains.html"

getCollectionReferrers

public ReferrerList getCollectionReferrers(java.util.Date date,
                                  java.lang.String domain,
                                  java.lang.String collectionId,
                                  int perPage,
                                  int page)
                                    throws FlickrException

Get a list of referrers from a given domain to a collection.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

domain - (Required) The domain to return referrers for. This should be a hostname (eg: "flickr.com") with no protocol or pathname.

collectionId - (Optional) The id of the collection to get stats for. If not provided, stats for all collections will be returned.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getCollectionReferrers.html"

getCollectionStats

public Stats getCollectionStats(java.lang.String collectionId,
                       java.util.Date date)
                         throws FlickrException

Get the number of views, comments and favorites on a collection for a given date.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

collectionId - (Required) The id (from the URL!) of the collection to get stats for.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getCollectionStats.htm"

getCSVFiles

public java.util.List<Csv> getCSVFiles()
                                throws FlickrException

Returns a list of URLs for text files containing all your stats data (from November 26th 2007 onwards) for the currently auth'd user.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getCSVFiles.html"

getPhotoDomains

public DomainList getPhotoDomains(java.util.Date date,
                         java.lang.String photoId,
                         int perPage,
                         int page)
                           throws FlickrException

Get a list of referring domains for a photo.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

photoId - (Optional) The id of the photo to get stats for. If not provided, stats for all photos will be returned.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotoDomains.html"

getPhotoReferrers

public ReferrerList getPhotoReferrers(java.util.Date date,
                             java.lang.String domain,
                             java.lang.String photoId,
                             int perPage,
                             int page)
                               throws FlickrException

Get a list of referrers from a given domain to a photo.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

domain - (Required) The domain to return referrers for. This should be a hostname (eg: "flickr.com") with no protocol or pathname.

photoId - (Optional) The id of the photo to get stats for. If not provided, stats for all photos will be returned.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotoReferrers.html"

getPhotoStats

public Stats getPhotoStats(java.lang.String photoId,
                  java.util.Date date)
                    throws FlickrException

Get the number of views, comments and favorites on a photo for a given date.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

photoId - (Required) The id of the photo to get stats for.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotoStats.htm"

getPhotosetDomains

public DomainList getPhotosetDomains(java.util.Date date,
                            java.lang.String photosetId,
                            int perPage,
                            int page)
                              throws FlickrException

Get a list of referring domains for a photoset.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

photosetId - (Optional) The id of the photoset to get stats for. If not provided, stats for all photos will be returned.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotosetDomains.html"

getPhotosetReferrers

public ReferrerList getPhotosetReferrers(java.util.Date date,
                                java.lang.String domain,
                                java.lang.String photosetId,
                                int perPage,
                                int page)
                                  throws FlickrException

Get a list of referrers from a given domain to a photoset.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

domain - (Required) The domain to return referrers for. This should be a hostname (eg: "flickr.com") with no protocol or pathname.

photosetId - (Optional) The id of the photoset to get stats for. If not provided, stats for all sets will be returned.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotosetReferrers.html"

getPhotosetStats

public Stats getPhotosetStats(java.lang.String photosetId,
                     java.util.Date date)
                       throws FlickrException

Get the number of views, comments and favorites on a photoset for a given date.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

photosetId - (Required) The id of the photoset to get stats for.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotosetStats.htm"

getPhotostreamDomains

public DomainList getPhotostreamDomains(java.util.Date date,
                               int perPage,
                               int page)
                                 throws FlickrException

Get a list of referring domains for a photostream.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotostreamDomains.html"

getPhotostreamReferrers

public ReferrerList getPhotostreamReferrers(java.util.Date date,
                                   java.lang.String domain,
                                   int perPage,
                                   int page)
                                     throws FlickrException

Get a list of referrers from a given domain to a user's photostream.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

domain - (Required) The domain to return referrers for. This should be a hostname (eg: "flickr.com") with no protocol or pathname.

perPage - (Optional) Number of domains to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotostreamReferrers.html"

getPhotostreamStats

public Stats getPhotostreamStats(java.util.Date date)
                          throws FlickrException

Get the number of views, comments and favorites on a photostream for a given date.

Parameters:

date - (Required) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPhotostreamStats.htm"

getPopularPhotos

public PhotoList<Photo> getPopularPhotos(java.util.Date date,
                                StatsSort sort,
                                int perPage,
                                int page)
                                  throws FlickrException

List the photos with the most views, comments or favorites.

Parameters:

date - (Optional) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day. If no date is provided, all time view counts will be returned.

sort - (Optional) The order in which to sort returned photos. Defaults to views. The possible values are views, comments and favorites. Other sort options are available through flickr.photos.search.

perPage - (Optional) Number of referrers to return per page. If this argument is omitted, it defaults to 25. The maximum allowed value is 100.

page - (Optional) The page of results to return. If this argument is omitted, it defaults to 1.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getPopularPhotos.html"

getTotalViews

public Totals getTotalViews(java.util.Date date)
                     throws FlickrException

Get the overall view counts for an account

Parameters:

date - (Optional) Stats will be returned for this date. A day according to Flickr Stats starts at midnight GMT for all users, and timestamps will automatically be rounded down to the start of the day. If no date is provided, all time view counts will be returned.

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.stats.getTotalViews.html"