Class: PirschApi::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/pirsch_api/client.rb

Constant Summary collapse

BASE_URL = 
'https://api.pirsch.io/api/v1'

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, client_secret:) ⇒ Client

Returns a new instance of Client.



8
9
10
11
 
# File 'lib/pirsch_api/client.rb', line 8

def initialize(client_id:, client_secret:)
  @client_id     = client_id.to_s
  @client_secret = client_secret.to_s
end

Instance Method Details

#active(filters: {}, domain:) ⇒ Object 



37
38
39
 
# File 'lib/pirsch_api/client.rb', line 37

def active(filters: {}, domain:)
  ActiveResource.new(client: self, filters: filters, domain: domain).run
end

#domains ⇒ Object 



21
22
23
 
# File 'lib/pirsch_api/client.rb', line 21

def domains
  DomainResource.new(client: self).run
end

#duration_page(filters: {}, domain:) ⇒ Object 



65
66
67
 
# File 'lib/pirsch_api/client.rb', line 65

def duration_page(filters: {}, domain:)
  DurationPageResource.new(client: self, filters: filters, domain: domain).run
end

#duration_session(filters: {}, domain:) ⇒ Object 



61
62
63
 
# File 'lib/pirsch_api/client.rb', line 61

def duration_session(filters: {}, domain:)
  DurationSessionResource.new(client: self, filters: filters, domain: domain).run
end

#events(filters: {}, domain:) ⇒ Object 



45
46
47
 
# File 'lib/pirsch_api/client.rb', line 45

def events(filters: {}, domain:)
  EventResource.new(client: self, filters: filters, domain: domain).run
end

#growth(filters: {}, domain:) ⇒ Object 



41
42
43
 
# File 'lib/pirsch_api/client.rb', line 41

def growth(filters: {}, domain:)
  GrowthResource.new(client: self, filters: filters, domain: domain).run
end

#pages(filters: {}, domain:) ⇒ Object 



29
30
31
 
# File 'lib/pirsch_api/client.rb', line 29

def pages(filters: {}, domain:)
  PageResource.new(client: self, filters: filters, domain: domain).run
end

#referrers(filters: {}, domain:) ⇒ Object 



33
34
35
 
# File 'lib/pirsch_api/client.rb', line 33

def referrers(filters: {}, domain:)
  ReferrerResource.new(client: self, filters: filters, domain: domain).run
end

#token ⇒ Object 



17
18
19
 
# File 'lib/pirsch_api/client.rb', line 17

def token
  @token ||= TokenResource.new(@client_id, @client_secret).run
end

#utm_campaign(filters: {}, domain:) ⇒ Object 



57
58
59
 
# File 'lib/pirsch_api/client.rb', line 57

def utm_campaign(filters: {}, domain:)
  UtmCampaignResource.new(client: self, filters: filters, domain: domain).run
end

#utm_medium(filters: {}, domain:) ⇒ Object 



53
54
55
 
# File 'lib/pirsch_api/client.rb', line 53

def utm_medium(filters: {}, domain:)
  UtmMediumResource.new(client: self, filters: filters, domain: domain).run
end

#utm_source(filters: {}, domain:) ⇒ Object 



49
50
51
 
# File 'lib/pirsch_api/client.rb', line 49

def utm_source(filters: {}, domain:)
  UtmSourceResource.new(client: self, filters: filters, domain: domain).run
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/pirsch_api/client.rb', line 13

def valid?
  true if token rescue false
end

#visitors(filters: {}, domain:) ⇒ Object 



25
26
27
 
# File 'lib/pirsch_api/client.rb', line 25

def visitors(filters: {}, domain:)
  VisitorResource.new(client: self, filters: filters, domain: domain).run
end