Class: HubSpotSDK::Resources::Marketing::Campaigns::Metrics

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/marketing/campaigns/metrics.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Metrics

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Metrics.

Parameters:



116
117
118
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/metrics.rb', line 116

def initialize(client:)
  @client = client
end

Instance Method Details

#get_attribution_metrics(campaign_guid, end_date: nil, start_date: nil, request_options: {}) ⇒ HubSpotSDK::Models::Marketing::MetricsCounters

This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.

Parameters:

  • campaign_guid (String) —

    The unique identifier of the campaign

  • end_date (String)
  • start_date (String)
  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/metrics.rb', line 24

def get_attribution_metrics(campaign_guid, params = {})
  parsed, options =
    HubSpotSDK::Marketing::Campaigns::MetricGetAttributionMetricsParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["marketing/campaigns/2026-03/%1$s/reports/metrics", campaign_guid],
    query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
    model: HubSpotSDK::Marketing::MetricsCounters,
    options: options
  )
end

#get_revenue_attribution(campaign_guid, attribution_model: nil, end_date: nil, start_date: nil, request_options: {}) ⇒ HubSpotSDK::Models::Marketing::RevenueAttributionAggregate

Fetch revenue attribution report data for a specified campaign

Parameters:

  • campaign_guid (String) —

    The unique identifier of the campaign

  • attribution_model (String)
  • end_date (String) —

    End date to fetch attribution data, YYYY-MM-DD

  • start_date (String) —

    Start date to fetch attribution data, YYYY-MM-DD

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/metrics.rb', line 54

def get_revenue_attribution(campaign_guid, params = {})
  parsed, options =
    HubSpotSDK::Marketing::Campaigns::MetricGetRevenueAttributionParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["marketing/campaigns/2026-03/%1$s/reports/revenue", campaign_guid],
    query: query.transform_keys(
      attribution_model: "attributionModel",
      end_date: "endDate",
      start_date: "startDate"
    ),
    model: HubSpotSDK::Marketing::RevenueAttributionAggregate,
    options: options
  )
end

#list_contact_ids_by_type(contact_type, campaign_guid:, after: nil, end_date: nil, limit: nil, start_date: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Marketing::ContactReference>

Some parameter documentations has been truncated, see Models::Marketing::Campaigns::MetricListContactIDsByTypeParams for more details.

Fetch the list of contact IDs for the specified campaign and contact type

Parameters:

  • contact_type (String) —

    Path param: The type of contact to filter the list

  • campaign_guid (String) —

    Path param: The unique identifier of the campaign

  • after (String) —

    Query param: The paging cursor token of the last successfully read resource will

  • end_date (String) —

    Query param

  • limit (Integer) —

    Query param: The maximum number of results to display per page.

  • start_date (String) —

    Query param

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/metrics.rb', line 96

def list_contact_ids_by_type(contact_type, params)
  parsed, options = HubSpotSDK::Marketing::Campaigns::MetricListContactIDsByTypeParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  campaign_guid =
    parsed.delete(:campaign_guid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["marketing/campaigns/2026-03/%1$s/reports/contacts/%2$s", campaign_guid, contact_type],
    query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Marketing::ContactReference,
    options: options
  )
end