Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

<type> on Visitor Activity differs from what's on the documentation #230

Open
johnissagc opened this issue Jun 25, 2020 · 3 comments
Open

Comments

@johnissagc
Copy link

Hello,

There looks to be a difference in <type> for what's listed on the documentation and the response we're receiving when calling the Visitor Activities API. For example, when I call the following:

GET: /api/visitorActivity/version/4/do/query?type=1
I get the following resposne:
<type>1</type>
<type_name>Email Tracker</type_name>

So in this particular case i'm expecting to receive "Click" but I receive "Email Tracker".

Is this the expected behavior to not receive the same values that are documented? Looking to get some more clarity on this subject.

Thank you!

Here are the type values that I'm referencing.
http://developer.pardot.com/kb/object-field-references/#visitor-activity-types
Documented Visitor Activity Types
1 - Click
2 - View
3 - Error
4 - Success
5 - Session
6 - Sent
7 - Search
8 - New Opportunity
9 - Opportunity Won
10 - Opportunity Lost
11 - Open
12 - Unsubscribe Page
13 - Bounced
14 - Spam Complaint
15 - Email Preference Page
16 - Resubscribed
17 - Click (Third Party)
18 - Opportunity Reopened
19 - Opportunity Linked
20 - Visit
21 - Custom URL click
22 - Olark Chat
23 - Invited to Webinar
24 - Attended Webinar
25 - Registered for Webinar
26 - Social Post Click
27 - Video View
28 - Event Registered
29 - Event Checked In
30 - Video Conversion
31 - UserVoice Suggestion
32 - UserVoice Comment
33 - UserVoice Ticket
34 - Video Watched (≥ 75% watched)
35 - Indirect Unsubscribe Open
36 - Indirect Bounce
37 - Indirect Resubscribed
38 - Opportunity Unlinked
Other - Unknown

Here are the values we receive when we pull type 1 through 38. Please note that "N/A" indicates that no records were found.

  1. Email Tracker
  2. Landing Page
  3. N/A
  4. N/A
  5. Visitor
  6. Email
  7. N/A
  8. New Opportunity
  9. N/A
  10. Opportunity Lost
  11. Email
  12. Email
  13. Email
  14. Email
  15. Empty value
  16. Email
  17. N/A
  18. N/A
  19. Opportunity Associated
  20. Visit
  21. N/A
  22. N/A
  23. N/A
  24. N/A
  25. N/A
  26. N/A
  27. N/A
  28. N/A
  29. N/A
  30. N/A
  31. N/A
  32. N/A
  33. N/A
  34. N/A
  35. Email
  36. Email
  37. Email
  38. N/A
@franciscosanchezsfdc
Copy link
Contributor

John, you can open a ticket with our Support team: https://help.salesforce.com/articleView?id=000181929&type=1
Thank you

@ghost
Copy link

ghost commented Jun 26, 2020

Unfortunately it does appear that the documentation for type and type_name is not descriptive enough.

  • type is a numeric value representing the type of activity the visitor engaged in. The value of this property corresponds to the list in the documentation. This numeric value represents a categorization that is machine readable.
  • type_name is record specific, and although based on the type of activity, it does not correspond to the value of type. The type_name property is calculated based on the data received when the activity was generated. This string value represents a human-readable message that describes the activity.

For example, if a visitor clicks an Email associated to a Tracker, the type will be 1 ("Click") and the type_name will be "Email Tracker". If a visitor clicks a Form associated to a Tracker, the type will still be 1 ("Click") however the type_name will be "Form Tracker". Both visitor activity records will have the same type value but different type_name values.

type type value type_name
1 Click Email Tracker
1 Click Form Tracker

The values for type_name are not enumerated in the documentation because they are generated with the data associated to the visitor activity.

Sorry for the confusion and I'll be passing this onto the technical writers to revise.

@johnissagc
Copy link
Author

John, you can open a ticket with our Support team: https://help.salesforce.com/articleView?id=000181929&type=1
Thank you

Francisco - that was my initial course of action and they advised that I open a ticket here...

Unfortunately it does appear that the documentation for type and type_name is not descriptive enough.

  • type is a numeric value representing the type of activity the visitor engaged in. The value of this property corresponds to the list in the documentation. This numeric value represents a categorization that is machine readable.
  • type_name is record specific, and although based on the type of activity, it does not correspond to the value of type. The type_name property is calculated based on the data received when the activity was generated. This string value represents a human-readable message that describes the activity.

For example, if a visitor clicks an Email associated to a Tracker, the type will be 1 ("Click") and the type_name will be "Email Tracker". If a visitor clicks a Form associated to a Tracker, the type will still be 1 ("Click") however the type_name will be "Form Tracker". Both visitor activity records will have the same type value but different type_name values.

type type value type_name
1 Click Email Tracker
1 Click Form Tracker
The values for type_name are not enumerated in the documentation because they are generated with the data associated to the visitor activity.

Sorry for the confusion and I'll be passing this onto the technical writers to revise.

Jared - this answers my question.

Appreciate the help here guys, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants