The Dev Console allows for increased visibility into the information being sent to ChurnZero, as well as the status of those calls. This is helpful for general investigation and identifying points of failure when data isn't getting into ChurnZero properly. This is also where you can find the API Names of Attributes that you will be sending to ChurnZero.
To access the dev console, enter the Admin space, then go to Data > Dev Console. If you do not see this option, you may need an Administrator to update your User Permission Group.
Dev Console Page
The settings to adjust what information is displayed within this page can be found at the top of the page. From left to right, those settings options are as follows:
Successes, Failures, or Both
The first drop-down lets you select if you'd like to view only calls that were successful, only calls that failed, or see both simultaneously. When looking at both success and failures, all failures will have the date show up in red with an associated error message, while successful calls will be shown in green.
Call Type
The next option is to adjust the type of call being shown. Options include:
-
API/JS- ContactConnected
This option will show you all ContactConnected calls made by the Javascript. This call is what is used to identify a user of your application and send that information to ChurnZero. If you are not seeing any information when you click refresh here, that means that the Javascript is not connecting when users are logging into your application. You must see information here if you plan on sending in app communication to your customers. The below example shows a successful connection for contact Crystal Bechtel -
API/JS SetAttribute
If you are updating attributes with our Javascript or HTTP API, then you will see all SetAttribute calls here. This section will show you whether the call updated an Account or Contact, as well as what attributes were updated. In the below example, the Contact Attribute of "Browser" was updated for a specific contact. -
API/JS Track Event
If you are using the TrackEvent call using our Javascript or HTTP API, this is where you can see if calls are successfully being made into your ChurnZero instance. The below example shows a successful "Login" Event logged for a contact. -
Import
This area will show you the status of any imports that you have done to Accounts, Contacts, Events, Tasks, or Custom Tables. If there are individual row failures, then an error message will show you exactly what that row had failed during the import. The below example shows a successful import with 1379 rows and 0 failures within those rows. -
Segment.com
If you are connecting to Segment.com for events or attribute data, we can see all of the calls being made to ChurnZero from Segment.com. You can even separate these out by only showing Group, Identify, or Track calls.
Time Frame
Define the time frame of calls being shown from the last 15 minutes to the last 72 hours.
Search Text
The text input will allow you to search within the calls. We recommend that you search by either account or contact external IDs for specific troubleshooting.
Refresh
It is important to note that when any setting is changed, "Refresh" MUST be clicked in order for those changes to take effect.
Samples Page
Use the "Samples" section to access the API Names of attributes that are created in CZ as well as see helpful sample calls you can use to get you started! In the top right-hand corner of the dev console you'll find the "Samples" button to access this information.
Entity and Method
At the top of the page there are fields to define the entity (accounts, contacts, tasks) and the method (Javascript API, HTTP GET, HTTP POST) for which you'd like to see the sample. Selecting the Entity determines which attributes you are going to see in the Attributes section, while the Method section allows the system to construct a sample call in the correct format.
Note: We only allow updates to Accounts and Contacts using our API and Javascript. If you want to update custom table records, that will need to be done either via a manual import or a csv import via our API.
Sample Call (for Account and Contact entities only)
Beneath where the entity and method have been selected, there will be a sample call to reference.
Attributes
At the bottom of the page are the attributes associated with the entity. For every attribute, there will be a column for the following data points
- CZ Name- Label of the ChurnZero Field
- API Name- the unique identifier of the field. Use this when making API calls
- Field Type- What type of field is our system expecting this to be (number, small text, date, etc.)
- Connected To- Label of connected system field (only applicable if field is connected via one of our out of the box integrations)
- Connected Field- API Name of connected system field (only applicable if field is connected via one of our out of the box integrations)
Comments
0 comments
Article is closed for comments.