io.cdap.plugin.hubspot.common

Enum ReportEndpoint

java.lang.Object

java.lang.Enum<ReportEndpoint>

io.cdap.plugin.hubspot.common.ReportEndpoint

All Implemented Interfaces:

Serializable, Comparable<ReportEndpoint>

public enum ReportEndpoint
extends Enum<ReportEndpoint>

Convenience enum to map ReportEndpoint UI selections to meaningful values. The analytics report type of content that you want to get data for. Must be one of:

landing-pages - Pull data for landing pages. standard-pages - Pull data for website pages. blog-posts - Pull data for individual blog posts. listing-pages - Pull data for blog listing pages. knowledge-articles - Pull data for knowledge base articles.

The analytics report category used to break down the analytics data. Must be one of:

totals - Data will be the totals rolled up from sessions - Data broken down by session details sources - Data broken down by traffic source geolocation - Data broken down by geographic location utm-:utm_type - Data broken down by the standard UTM parameters. :utm_type must be one of campaigns, contents, mediums, sources, or terms (i.e. utm-campaigns).

The analytics report type of object that you want the analytics data for. Must be one of:

event-completions - Get data for analytics events. The results are broken down by the event ID. You can get the details for the events using this endpoint. forms - Get data for your HubSpot forms. The results are broken down by form guids. You can get the details for the forms through the Forms API. pages - Get data for all URLs with data collected by HubSpot tracking code. The results are broken down by URL. social-assists - Get data for messages published through the social publishing tools. The results are broken down by the broadcastGuid of the messages. You can get the details of those messages through the Social Media API.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOG_POSTS
EVENT_COMPLETIONS
FORMS
GEOLOCATION
KNOWLEDGE_ARTICLES
LANDING_PAGES
LISTING_PAGES
PAGES
SESSIONS
SOCIAL_ASSISTS
SOURCES
STANDARD_PAGES
TOTALS
UTM_CAMPAIGNS
UTM_CONTENTS
UTM_MEDIUMS
UTM_SOURCES
UTM_TERMS

Method Summary

Modifier and Type	Method and Description
static ReportEndpoint	fromString(String value) Returns the ReportEndpoint.
String	getStringValue()
static ReportEndpoint	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportEndpoint[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LANDING_PAGES

public static final ReportEndpoint LANDING_PAGES

STANDARD_PAGES

public static final ReportEndpoint STANDARD_PAGES

BLOG_POSTS

public static final ReportEndpoint BLOG_POSTS

LISTING_PAGES

public static final ReportEndpoint LISTING_PAGES

KNOWLEDGE_ARTICLES

public static final ReportEndpoint KNOWLEDGE_ARTICLES

TOTALS

public static final ReportEndpoint TOTALS

SESSIONS

public static final ReportEndpoint SESSIONS

SOURCES

public static final ReportEndpoint SOURCES

GEOLOCATION

public static final ReportEndpoint GEOLOCATION

UTM_CAMPAIGNS

public static final ReportEndpoint UTM_CAMPAIGNS

UTM_CONTENTS

public static final ReportEndpoint UTM_CONTENTS

UTM_MEDIUMS

public static final ReportEndpoint UTM_MEDIUMS

UTM_SOURCES

public static final ReportEndpoint UTM_SOURCES

UTM_TERMS

public static final ReportEndpoint UTM_TERMS

EVENT_COMPLETIONS

public static final ReportEndpoint EVENT_COMPLETIONS

FORMS

public static final ReportEndpoint FORMS

PAGES

public static final ReportEndpoint PAGES

SOCIAL_ASSISTS

public static final ReportEndpoint SOCIAL_ASSISTS

Method Detail

values

public static ReportEndpoint[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReportEndpoint c : ReportEndpoint.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReportEndpoint valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static ReportEndpoint fromString(String value)

Returns the ReportEndpoint.

Parameters:

value - the value is string type

Returns:

the ReportEndpoint

getStringValue

public String getStringValue()