This is a dynamic API that will adjust as customizations are made to your ChurnZero instance and as new features are developed for ChurnZero. In the case of using $top, there will no provided @odata.nextLink property in the response. The date/time the Journey record was last modified. ISO 8601 formatted string. The ID of the Churn Score Factor associated with this calculation. Likewise, if fields are removed from the synced set of data those fields will cease to be available from the ChurnZero REST API. ISO 8601 formatted string. The underlying model/schema has changed. Accessed dynamically through Segment Column Set selection. multiple resources, they can all be included by referencing the properties with a comma separated list. The JourneyMilestone associated with this progress. This represents the progress of the associated Task or Achievement from the perspective of the Journey. To find the setup key, navigate to Admin > Application Keys > New App Key and create a new key with the name of your choice. This may be null and is mutually exclusive with JourneyMilestoneTaskId. ISO 8601 formatted string. Journey definition available in ChurnZero. Instead, it will be incumbent on the caller to continue to increase $skip by the desired amount until an empty result set is observed. The date/time the JourneyMilestoneTask record was created. Inspect all the traffic coming and going to the Churnzero API and optionally inject tokens at runtime.
The $filter option allows limiting of resources in the collection that is returned for the requested URL. The source of the survey response. Visit the Schemas section of Churnzero's. +160 Tools to build and augment your SaaS application. The date/time the JourneyMilestoneProgress record was created. All Accounts with the related UserAccount and PrimaryChurnScore embedded inline. 1245) noted at the bottom. must be used. Accessed dynamically through Segment Column Set selection. You have the option to add this ID to the beginning, end, etc. The number of days this Account has left for the Journey according to the epectation. True if the Account has failed the Journey. The day this Journey was evaluated for the Account. When there are no more results, an empty result set will be returned. ISO 8601 formatted string. ISO 8601 formatted string. For example, Email eq '[emailprotected]' should be encoded as Email eq 'user%[emailprotected]'
The $select option allows resource results to only include the specified properties. The Churn Score History related to an Account. In a given filter operation, The Account's status in the JourneyMilestone. Journey Milestone Step progress of Accounts. GET /ChurnScoreFactorCalculation({Id})/Account, GET /ChurnScoreFactorCalculation({Id})/ChurnScore, GET /ChurnScoreFactorCalculation({Id})/ChurnScoreFactor. Visit the Developers Guide to see more examples and to begin using the API. The end of the collection will be signified by a response with an empty result set. The preferred means of relating a record back to an account is through an ID, specifically the account's External ID. True if the Account has completed the journey. ISO 8601 formatted string. Survey response collected in ChurnZero for a Survey. $select can be used in conjunction with $expand to tailor the payload for related resources that are inlined with the response. The overall status associated with the Task or Achievement represented by this progress. The #1 integration marketplace builder for SaaS companies. There is no default mapping for this. Most notably, anything specified via $filter will affect the count returned. ISO 8601 formatted string. ISO 8601 formatted string. The Churn Score related to an Account. True if the Segment is globally accessible. The date the Account ended the Journey. GET /ChurnScoreCalculation({Id})/ChurnScore. the following would be a cURL command manually encoding the header. The Contact's combined First Name, Last Name, and Email if available. ISO 8601 formatted string. The date/time the SegmentColumnSet record was last modified. ISO 8601 formatted string. We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data. The Segment must belong to the entity in the request. ISO 8601 formatted string. Note: this can be found in the top left of your contact or account page (not the ID in the url). The Attributes related to an Account/Contact. The date the Account ended the JourneyMilestone. True if the User Account can log into ChurnZero. Easy to integrate within your current codebase. The due date of the Task. (Draft, Paused, Running, Complete, Archived), The campaign type of the survey. Within Teamwork, you can use your companies to map their associated projects and tasks to accounts and contacts in ChurnZero. The ID of the Account associated with this calculation.
(Standard, PointInTime, External). The number of Total Events for the Event Type. The account ID is the user account the custom table is associated with: This can be found by clicking on your name at the top and selecting "My Account"; your ID is at the end of the URL. Accessed dynamically through Segment Column Set selection. Typically this is just a combination of FirstName and LastName. account ID referenced or a custom field exists or not. A GPT-3 directory covering 150+ apps, use-cases, examples, and demos. Two thresholds are tracked per minute. Apideck offers native SDKs in several popular programming languages and frameworks. ISO 8601 formatted string. The Id of the Account associated with this Contact. ChurnZero is a real-time customer success platform that helps you understand your customers' product usage, assesses their health, and enable you to manage the customer experience. The date/time the Contact record was last modified. The date/time the JourneyMilestoneTask record was last modified. GET /JourneyMilestoneTask({Id})/JourneyMilestone. The authentication and request syntax was valid but the server is refusing to complete the request. The JourneyMilestone that this JourneyMilestoneTask belongs too. The calculated number of Active Contacts. Accessed dynamically through Segment Column Set selection. True if the Account has failed the journey. All Accounts with a BillingAddressState equal to 'VA', All Accounts with a TotalContractAmount greater than 10000, All Accounts that have IsActive equal to true, All Accounts that have a Name that starts with 'A', All Accounts that have a ObjectCreatedDate greater than 2020-01-01, All Accounts that have the Custom Field Subscribed equal to true, All Accounts with a BillingAddressState equal to 'VA' and a TotalContractAmount greater than 10000. True if the Account has completed the Journey. ChurnZero needs to know that every time a company is mapped, the ID is in the same place. Helping you discover the best APIs and SaaS products to integrate with. In addition to instance specific customizations, new features will be added to the API as they become available. This count will take into account all the provided query options. Similar to using a Segment, using a predefined Segment Column Set in the ChurnZero REST API is achieved by utilizing the Segment Column Set id in a $filter option on an entity that supports Segments. The $count option indicates that the collection response should include the overall count of resources in the collection. The ID of the Churn Score associated with this calculation. ISO 8601 formatted string. The number of Most Recent Events for the Event Type. The code will just be the numeric HTTP Status code as a string, and the message will provide more detail if possible. Survey definition available in ChurnZero. Open-source software is part of our core. GET /JourneyMilestoneAchievement({Id})/JourneyMilestone. The type of answer associated with the question. The number of days this Account has been in the JourneyMilestone. The number of days this Account has been in the Journey. For fields to properly be inserted into a custom table from Hightouch, they
A set of state-the-art unified APIs to build native integrations with other SaaS providers. The * option for $expand is a special option that means include all referenced entities. The sync targets projects, tasks, and milestones: For each of these, ChurnZero must be given explicit instructions on how to relate a record back to an account. Churnzero requires that you map at least one default (standard) field in order When you view one of the companies in ChurnZero, the associated projects will show up. The date the Account entered the journey. The date/time the JourneyMilestoneStepProgress record was created. ISO 8601 formatted string. The name of the JourneyMilestoneAchievement. The day this JourneyMilestone was evaluated for the Account. Wrap existing Churnzero API calls with the Apideck Proxy endpoint. The proxy allows you to bypass the token injection and provide custom Authorization headers. The top 10 Accounts ordered by ObjectLastModifiedDate. The set of predefined reasons for failing the Journey. All filters used in conjunction with Segments must use the 'and' operator. The date/time the Contact record was created. The JourneyMilestoneAchievement associated with this progress. This is a one-way sync from Teamwork to ChurnZero: ChurnZero provides a quick link to each project and task in Teamwork, but projects and tasks cannot be edited in ChurnZero. Monitoring APIs to guarantee API compliance and data consistency. ISO 8601 formatted string. The close date of the Task. The ID of the Account associated with this survey response. The Contact's full name. GET /JourneyMilestoneStepProgress({Id})/Account, GET /JourneyMilestoneStepProgress({Id})/Journey, GET /JourneyMilestoneStepProgress({Id})/JourneyInstance, GET /JourneyMilestoneStepProgress({Id})/JourneyMilestone, GET /JourneyMilestoneStepProgress({Id})/JourneyMilestoneAchievement, GET /JourneyMilestoneStepProgress({Id})/JourneyMilestoneTask, GET /JourneyMilestoneStepProgress({Id})/Task, GET /JourneyMilestoneStepProgress({Id})/TaskStatus. The date/time the JourneyMilestoneStepProgress record was last modified. Easily showcase integrations, partners, and apps to your customers.
This is done at the account and/or contact level. String matching is possible (e.g. Churn Score Calculation available in ChurnZero. Using the ChurnZero Integration with Teamwork Desk, Your hostname is your Teamwork site URL without the https://. True if this Achievement is externally visible. ISO 8601 formatted string. We don't receive detailed errors from Churnzero, such as checking whether an Accessed dynamically through Segment Column Set selection. The number of choices available to answer a survey. The API Explorer is an interactive interface you can use to build, view, and send HTTP requests that call Apideck APIs without leaving the browser. ISO 8601 formatted string. ISO 8601 formatted string. by name) but is significantly less accurate. The Segment must belong to the authorized API User or be configured as a Global Segment. The desired Time Frame of the calculation. Collections that support the $orderby operation will list the available resource properties that can be used for ordering. If the desired filter cannot be constructed with the available simple or complex operands, then ChurnZero Segments able to provide detailed logging. ISO 8601 formatted string. The following tables list some common data types supported by the ChurnZero REST API. The data type of the follow up answer. This usually occurs because of a missing or malformed parameter. Accessed dynamically through Segment Column Set selection. +100 Tools to extend your remote stack, ranging from Collaborative Design, Video Conferencing to Virtual Offices. The Event Type associated to an Event aggregate. The Id that this Contact is linked to in an external source. Include the total count of Accounts in the query for the Id,Name, and ExternalId of all Accounts. The $expand option allows related resources to be included in the response inline.
Volume packaging is available on request. The date/time the JourneyMilestoneAchievement record was created. Follow up question that can be associated with a survey. Rate limits are applied to a specific ChurnZero instance on a per minute basis. These are limited to Account, Contact, Event, and Custom Table entities and can be discovered by making a request to the SegmentColumnSet endpoint. The Journey that this JourneyInstance belongs too. The Id of the Account associated with this Task. The date/time the Account record was last modified. Pre-made building blocks to get started with Apideck. Name, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, TenureInDays, PrimaryChurnScoreValue, ContactsCount, ObjectCreatedDate, ObjectLastModifiedDate, ExternalId, CrmId, UserAccountId, ParentAccountId, PrimaryChurnScoreId, IsActive, Use/SegmentId, Use/SegmentColumnSetId, Name, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, TenureInDays, PrimaryChurnScoreValue, ContactsCount, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, UserAccountId, NextRenewalDate, ParentNextRenewalDate, TotalContractAmount, ParentTotalContractAmount, IsActive, ExternalId, BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressState, BillingAddressZip, BillingAddressCountry, StartDate, EndDate, LicenseCount, CrmId, TenureInDays, PrimaryChurnScoreId, PrimaryChurnScoreValue, UsageFrequency, ContactsCount, ParentAccountId, Tags, ObjectCreatedDate, ObjectLastModifiedDate, *, PrimaryChurnScore, ParentAccount, UserAccount, Id, UserName, FirstName, LastName, Name, Email, HasAccounts, AvatarUrl, MobilePhone, OfficePhone, Title, CanLogIn, CrmId, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, FirstName, LastName, FullName, Email, Name, MarketingEmailUnsubscribed, ObjectCreatedDate, ObjectLastModifiedDate, ExternalId, CrmId, AccountId, Use/SegmentId, Use/SegmentColumnSetId, FirstName, LastName, FullName, Email, Name, MarketingEmailUnsubscribed, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, FirstName, LastName, FullName, Email, Name, ExternalId, CrmId, MarketingEmailUnsubscribed, Tags, ObjectCreatedDate, ObjectLastModifiedDate, UserName, FirstName, LastName, Name, Email, HasAccounts, MobilePhone, OfficePhone, Title, CanLogIn, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, CrmId, UserName, FirstName, LastName, Name, Email, HasAccounts, MobilePhone, OfficePhone, Title, CanLogIn, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, EventDate, Quantity, AccountId, ContactId, EventTypeId, Use/SegmentId, Use/SegmentColumnSetId, Id, AccountId, ContactId, EventTypeId, EventDate, Quantity, Description, Name, Entity, IsGlobal, ObjectCreatedDate, ObjectLastModifiedDate, Name, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, Entity, IsGlobal, ObjectCreatedDate, ObjectLastModifiedDate, Name, Entity, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, Entity, ShareType, UserAccountId, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, Use/SegmentId, Use/SegmentColumnSetId, Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, ContactId, UserAccountId, TaskPriorityId, TaskStatusId, Subject, DueDate, CloseDate, IsClosed, IsHighPriority, Comments, CrmId, TaskType, ObjectCreatedDate, ObjectLastModifiedDate, *, Account, Contact, UserAccount, TaskPriority, TaskStatus, Id, Name, IsActive, DripOverMonths, RecurringEveryMonths, SurveyType, Id, Name, DripOverMonths, RecurringEveryMonths, Id, Name, IsActive, DripOverMonths, RecurringEveryMonths, SurveyType, CampaignStatus, CampaignType, Settings, SegmentIds, SurveyQuestion, FollowUpQuestions, Id, AccountId, ContactId, NextReminderDate, SurveyId, ResponseDate, Id, ContactId, AccountId, NextReminderDate, SurveyId, Score, Comment, ResponseDate, ResponseSource, NextReminderDate, FollowUpResponse, FollowUpQuestion, FollowUpAnswerType, Id, ChurnScoreId, ChurnScoreFactorType, Name, Id, Name, Description, IsActive, Status, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, ExpectedDuration, ProgressTop, ProgressBottom, CalculationDay, Score, IsActive, IsPrimary, AccountId, ChurnScoreId, CalculationDay, Score, IsActive, IsPrimary, Id, AccountId, ChurnScoreId, CalculationDay, Score, IsActive, IsPrimary, CalculationDay, Score, AccountId, ChurnScoreId, ChurnScoreFactorId, Id, AccountId, ChurnScoreId, CalculationDay, ChurnScoreFactorId, Score, ChurnScoreFactor, Id, Name, IsActive, ObjectCreatedDate, ObjectLastModifiedDate, IsSharedExternally, Id, Name, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, JourneyId, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, Description, JourneyId, ExpectedDuration, ProgressTop, ProgressBottom, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, JourneyMilestoneId, IsOptional, IsExternallyVisible, IsConditional, ObjectCreatedDate, ObjectLastModifiedDate, Id, Name, IsOptional, IsConditional, IsExternallyVisible, JourneyMilestoneId, ObjectCreatedDate, ObjectLastModifiedDate, Id, Subject, JourneyMilestoneId, IsOptional, IsConditional, IsExternallyVisible, ObjectCreatedDate, ObjectLastModifiedDate, Id, Subject, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, JourneyId, JourneyInstanceId, ObjectCreatedDate, ObjectLastModifiedDate, Id, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, JourneyId, JourneyInstanceId, IsCompleted, IsFailed, Status, BeginDate, EndDate, DaysIn, DaysLeft, DaysOver, FailureReasons, FailureComments, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, JourneyId, JourneyMilestoneId, ObjectCreatedDate, ObjectLastModifiedDate, Id, BeginDate, EndDate, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, JourneyId, JourneyMilestoneId, JourneyInstanceId, IsCompleted, IsFailed, Status, BeginDate, EndDate, DaysIn, DaysLeft, DaysOver, EvaluationDay, ObjectCreatedDate, ObjectLastModifiedDate, *, Account, Journey, JourneyMilestone, JourneyInstance, Id, AccountId, JourneyId, JourneyMilestoneId, JourneyMilestoneAchievementId, JourneyMilestoneTaskId, JourneyInstanceId, TaskStatusId, TaskId, ObjectCreatedDate, ObjectLastModifiedDate, Id, AccountId, JourneyId, JourneyMilestoneId, JourneyMilestoneAchievementId, JourneyMilestoneTaskId, JourneyInstanceId, TaskId, TaskStatusId, IsCompleted, ObjectCreatedDate, ObjectLastModifiedDate, *, Account, Journey, JourneyMilestone, JourneyInstance, JourneyMilestoneAchievement, JourneyMilestoneTask, Task, TaskStatus, EventCount, SegmentBonus, ActiveContacts, LicenseUtilization, Tenure, RenewalAmount, TimeInApp, ActiveDays, AccountAttribute, TaskLoggedActivities, TaskMostRecentActivity, CustomTable, NumberOfContactMessagesSent, MostRecentMessageSent, JourneyProgress, NumberOfContactMessagesReceived, MostRecentMessageReceived, NumberOfContactMessagesSentOrReceived, MostRecentMessageSentOrReceived, SurveyScore, SuccessInsights, Account, Contact, Event, Task, CustomListTicket, CustomListOpportunities, CustomListFinancialData, CustomListCourseCompletions, CustomListStrategicInitiatives, CustomListOrganization, CustomListProductFeedback, CustomListProductsPurchased, CustomListExecutiveBusinessReviewGoals, CustomListExpansionUpsellTracking, ?$filter=IsActive eq true and Use/SegmentColumnSetId eq 25, ?$filter=Use/SegmentId eq 6763 and Use/SegmentColumnSetId eq 25, ?$select=Name&$filter=Use/SegmentId eq 6763 and Use/SegmentColumnSetId eq 25, /Account(AccountExternalId='{AccountExternalId}'), /Contact(AccountExternalId='{AccountExternalId}',ContactExternalId='{ContactExternalId}'), /ChurnScoreFactorCalculation({Id})/Account, /ChurnScoreFactorCalculation({Id})/ChurnScore, /ChurnScoreFactorCalculation({Id})/ChurnScoreFactor, /JourneyMilestoneAchievement({Id})/JourneyMilestone, /JourneyMilestoneTask({Id})/JourneyMilestone, /JourneyMilestoneProgress({Id})/JourneyInstance, /JourneyMilestoneProgress({Id})/JourneyMilestone, /JourneyMilestoneStepProgress({Id})/Account, /JourneyMilestoneStepProgress({Id})/Journey, /JourneyMilestoneStepProgress({Id})/JourneyInstance, /JourneyMilestoneStepProgress({Id})/JourneyMilestone, /JourneyMilestoneStepProgress({Id})/JourneyMilestoneAchievement, /JourneyMilestoneStepProgress({Id})/JourneyMilestoneTask, /JourneyMilestoneStepProgress({Id})/TaskStatus, Get a Contact by AccountExternalId and ContactExternalId. These are limited to Account, Contact, Event, and Custom Tables (examples: Zendesk Tickets, Salesforce Opportunities, Intercom Conversations). The Maximum Event Date for the Event Type. The number of days the Account is past the completion date. True if the Account has failed the JourneyMilestone. ISO 8601 formatted string. A subset of the query string options defined in OData v4 are available for use to tailor access to the data in your ChurnZero instance. The top 10 Accounts ordered by ObjectLastModifiedDate, but skip 30 Accounts. The Survey Response related to a Contact. The Id of the Contact associated with this Event. The number of days this Account has left for the JourneyMilestone according to the epectation. The date the next reminder will occur. True if the User Account owns Accounts in ChurnZero. ISO 8601 formatted string. The number of days the Account has been in the journey. (Announcement, Email). Once you have the setup step completed, you will need to contact your ChurnZero implementation specialist or CSM with the following: In Teamwork, your company names should be updated to include the relevant External ID as specified in the mapping information sent to ChurnZero. Once your custom table is created, the table ID is found by going into Admin/Imports, and then selecting the custom table name from the dropdown there. Due to the large amounts of data that can be accessed through the REST API, there is a group of Bulk Read Permissions that must be set in order to gain access to the available Entities. On re-entry, the Account will be associated with a new JourneyInstance. The operating system to build and showcase integrations. The number of months until the survey reoccurs. The date the Contact completed the survey. True if the Contact has chosen to unsubscribe from marketing emails. Our team is relentlessly focused on your success. The date/time the Segment record was created. The date the Account entered the Journey. The number of days since this Account's start date. Login to view your personalized documentation. Ready to scale your integration strategy? Include the External ID mechanism you plan to use to map your projects by adding the External ID mechanism to your company names in Teamwork. The number of days this Account is over the expectation for the Journey. The start date of this JourneyInstance ISO 8601 formatted string. The date/time this Account ended. These properties are automatically added to $select/$expand options where applicable. Since Teamwork does not support custom fields on any of these entities so ChurnZero will pull the standard fields for each entity. Inspect all the traffic going to the Churnzero API. All Accounts with the related UserAccount embedded inline. Fight customer churn with fresh customer data in Churnzero. Check the documentation and the syntax of your request and try again. Custom tables may be created by going to the admin tab in Churnzero and selecting "Custom Fields". Ascending order can be explicitly specified with asc.
