You can sync custom tables using Hightouch through Churnzero's batch import API. They are set individually so that access to certain Entities can be controlled on a per-group basis. All Accounts with all related resources embedded inline. True if the calculation is deemed active. The date/time the JourneyProgress record was created. The Journey that this JourneyMilestone belongs too. You will first need to authorize your Teamwork instance in ChurnZero. Inspect all the traffic coming and going to the Churnzero API and optionally inject tokens at runtime. The comment that was given for the survey response. In order to see projects from your Teamwork site in your ChurnZero account, you will need to map this external ID by editing the associated company's name. such as BillingAddressState eq 'VA', while a complex operand combines simple operands with the and or or operartors. ISO 8601 formatted string. This is useful to tailor response payloads to reduce the amount of data being returned. The Journey that this JourneyInstance belongs too. A valid authentication token was not provided with the request, so the API could not associate a user with the request. The overall status associated with the Task or Achievement represented by this progress. If a particular resource is related to True if the Account has failed the journey. You can view these requests and response payloads on the logs overview and dashboard. Churn Score Factor Calculation available in ChurnZero. 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. You have set up the Teamwork integration. The JourneyInstance assocated with this progress. For example, an Account references a UserAccount. The Segment must belong to the authorized API User or be configured as a Global Segment. The Id that this User Account is linked to in an external source. This represents the progress of the associated Task or Achievement from the perspective of the Journey. ISO 8601 formatted string. A simple operand would deal with just one property ISO 8601 formatted string. Errors will follow the standard OData error format as shown below. Tracking 15,000+ APIs and SaaS products. The ID of the Survey associated with this survey response. The score that was given for the survey response. ISO 8601 formatted string. The date/time the UserAccount record was last modified. The SegmentColumnSet filter operator must be 'eq'. The lower-bounds value of the grading scale. We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data. The Id of the Journey associated with the Account. True if the Task Priority is high priority. The Id of the ChurnScore that is marked as primary for this Account. When viewing this newly created account, you can see the External ID (e.g. Pull and push normalized data to any connector through our GraphQL API. In the setup screen, enter in your host name and API token. For fields to properly be inserted into a custom table from Hightouch, they This is the template that is used to create a Task instance for Accounts that enter the JourneyMilestone. Accessed dynamically through Segment Column Set selection. 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. Hightouch supports syncing to the following Churnzero types: Hightouch supports syncing to the following Churnzero objects: Contacts must be associated with an account, and therefore an account external ID must be present in your data. Project and task data is supplemental data in ChurnZero: Project and task data can be used in segment and can be used to trigger alerts. The ID of the Account associated with this calculation. The number of days this Account has been in the Journey. The date/time the Journey record was last modified. The date/time this Account started. Use the application key as your "App Key" in Hightouch. 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.

must first be created within Churnzero on the "Custom Fields" page. The date/time the JourneyMilestoneAchievement record was created. All Accounts ordered by LicenseCount in descending order, then by ObjectLastModifiedDate in ascending order. The JourneyMilestone that this JourneyMilestoneTask belongs too. +100 Tools to extend your remote stack, ranging from Collaborative Design, Video Conferencing to Virtual Offices. 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.

The date/time the JourneyMilestoneAchievement record was last modified. 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. Records can be matched from your source to your Churnzero workspace by your Churnzero Contact / Account ID. The Id that this Contact is linked to in an external source. These are limited to Account, Contact, Event, and Custom Table entities and can be discovered by making a request to the SegmentColumnSet endpoint. The Churn Score related to an Account. 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. (Text, YesNo, Currency, Date, Number, Percent, SingleSelect, MultiSelect). The ID that this Account is linked to in an external source. The start date of this JourneyInstance ISO 8601 formatted string. See the documentation on rate limiting for more information. The number of days this Account has left for the Journey according to the epectation. ISO 8601 formatted string. The Id that this Task is linked to in an external source. The ChurnZero REST API is an OData v4 implementation that is accessible to developers and tools that know how to interact with OData v4 like Microsoft Excel, Tableau, or Microsoft Power BI. account ID referenced or a custom field exists or not. The source of the survey response. The Total Contract Amount of this Account. 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. If a different page size is desired, the $top operation can be used in conjunction with $skip. The date/time the Segment record was created. All Accounts with the related UserAccount and PrimaryChurnScore embedded inline. Survey response collected in ChurnZero for a Survey. All resources of the collection can be addressed by using $skip as defined in the provided @odata.nextLink property. Apideck offers native SDKs in several popular programming languages and frameworks. Additionally, there is a limit of 5 and or or operators in a single filter expression. and and or operators cannot be combined. The number of Most Recent Events for the Event Type. Scroll down for code samples, example requests and responses. The date/time the Account record was created. The number of days the Account is past the completion date. This is the interface for interacting with the ChurnZero Platform. For custom fields, please use the CZ API Name as the name of the destination field in Hightouch. Tracking 3,200+ open banking and PSD2 APIs from challenger banks, TPPs, and financial institutions. The date/time the Segment record was last modified. You can sync columns from your source to Churnzero's default and custom fields. Volume packaging is available on request. ISO 8601 formatted string. The proxy allows you to bypass the token injection and provide custom Authorization headers. Using a predefined Segment in the ChurnZero REST API is achieved by utilizing the Segment id in a $filter option on an entity that supports Segments. Our Developer-friendly plan includes 20,000 API calls per month and is designed to allow a wide range of use cases. The JourneyMilestone that this JourneyMilestoneAchievement belongs too. When building a request using Basic Authentication, make sure you add the Authorization header with a value of Basic : where : has been base64 encoded. The number of days this Account has been in the JourneyMilestone. least one default (standard) field. Accessed dynamically through Segment Column Set selection. The date the Account ended the Journey. The JourneyInstance assocated with this progress. ISO 8601 formatted string. JourneyMilestone definition available in ChurnZero. Journey Milestone Step progress of Accounts. The authentication and request syntax was valid but the server is refusing to complete the request. The date/time the JourneyMilestoneTask record was last modified. Usually caused by a race condition. The follow up question associated with this survey response. The underlying model/schema has changed.

Fight customer churn with fresh customer data in Churnzero. GET /JourneyMilestoneAchievement({Id})/JourneyMilestone. ISO 8601 formatted string. Track PII across all API traffic. In a given filter operation, The number of days the Account has been in the journey. Inspect all the traffic going to the Churnzero API. JourneyMilestoneTask definition available in ChurnZero. Select the Id, Name, and ExternalId for all Accounts, Select the Id, Name, and ExternalId for all Accounts and the UserName of related UserAccounts. The accessibility of the SegmentColumnSet. Easily showcase integrations, partners, and apps to your customers. The number of days an Account is expected to be in the Journey, True if this Journey is configured for sharing. The date/time the UserAccount record was created. When there are no more results, an empty result set will be returned. The higher-bounds value of the grading scale. Log in to your ChurnZero Production account and go to. Visit the Developers Guide to see more examples and to begin using the API. Accessed dynamically through Segment Column Set selection. The number of days since this Account's start date. Delivering the best-in-class products to boost your platform strategy. The $filter option allows limiting of resources in the collection that is returned for the requested URL. ISO 8601 formatted string. ISO 8601 formatted string. GET /JourneyProgress({Id})/JourneyInstance, GET /JourneyMilestoneProgress({Id})/Account, GET /JourneyMilestoneProgress({Id})/Journey, GET /JourneyMilestoneProgress({Id})/JourneyInstance, GET /JourneyMilestoneProgress({Id})/JourneyMilestone. If you use primarily custom fields, make sure to also map at Accessed dynamically through Segment Column Set selection. Accessed dynamically through Segment Column Set selection. The Total Contract Amount of the Parent Account. able to provide detailed logging. Connection issues with your data warehouse? The close date of the Task. or possibly Email%20eq%20%27user%2B1%40domain.com%27. We don't receive detailed errors from Churnzero, such as checking whether an String matching is possible (e.g. ISO 8601 formatted string. The number of requests under the soft max will execute at normal speed. Sending the request again will succeed. 1245) noted at the bottom. The Id of the Account associated with this Task. This may be null and is mutually exclusive with JourneyMilestoneAchievementId. The date/time this Account ended. ISO 8601 formatted string. The permissions are made up of the following: These permissions are configured for a User Permission Group and affect all users belonging to that group. The number of Distinct Contacts for the Event Type. Using the ChurnZero Integration with Teamwork Desk, Your hostname is your Teamwork site URL without the https://. The date/time the JourneyMilestone record was last modified. The Survey Response related to a Contact. The date the Account entered the Journey. Inject tokens at runtime. Port OpenAPI Specs to Postman Collections, and inject test suite. The desired Time Frame of the calculation. Discovering a Segment id (6763) from the URL within the ChurnZero application, Retrieving All available Account Segments via the API, Using a Segment id to retrieve All Accounts that meet the segment criteria for id 6763. ChurnZero needs to know that every time a company is mapped, the ID is in the same place. Check the documentation and the syntax of your request and try again. The ID of the Churn Score Factor associated with this calculation. We offer a GraphQL API that integrates every Unified API. Wrap existing Churnzero API calls with the Apideck Proxy endpoint. True if the User Account owns Accounts in ChurnZero. The date the Contact completed the survey. Free form comments associated with the Account failing the Journey.

The Id of the Contact associated with this Event. The JourneyInstance in ChurnZero represents a single progression of an Account through a Journey. E.g. multiple resources, they can all be included by referencing the properties with a comma separated list. The top 10 Accounts ordered by ObjectLastModifiedDate, but skip 30 Accounts. Check out the latest new about Apideck and SaaS ecosystems on our blog, Interviews with the leading SaaS companies who are building next-generation platforms and ecosystems. The ID of the Contact associated with this survey response. The status of the survey. The Account's status in the JourneyMilestone. manager handle The name of the JourneyMilestoneAchievement. ISO 8601 formatted string. Journey definition available in ChurnZero.

You have exceeded one of the enforced rate limits in the API. GET /ChurnScoreFactorCalculation({Id})/Account, GET /ChurnScoreFactorCalculation({Id})/ChurnScore, GET /ChurnScoreFactorCalculation({Id})/ChurnScoreFactor. The date the Account ended the JourneyMilestone. The Contact's full name. ISO 8601 formatted string. Map my projects from Company A using the External ID in this mechanism: '[External ID] Company A'. A single string value that belongs to a picklist, Represents a 64-bit signed integer (used for internal identifiers), A Positive or negative number with or without decimals. The Event Type associated to an Event aggregate. Human-friendly JSON Schema validation for APIs.

Our API reference is generated from our OpenAPI spec.

saas smartkarrot In the case of using $top, there will no provided @odata.nextLink property in the response. ISO 8601 formatted string. ISO 8601 formatted string. The page size for all collection requests is 100 results. Retrieving All available Account SegmentColumnSets via the API, Retrieve All Accounts and return only the fields configured for Segment Column Set id 25, Retrieve All Active Accounts and return only the fields configured for Segment Column Set id 25, Retrieve All Accounts for a defined Segment and return only the fields configured for Segment Column Set id 25, Retrieve All Accounts for a defined Segment and return the fields configured for Segment Column Set id 25 along with Account Name. Read the announcement, Broederminstraat 9, 2018 Antwerp, Belgium. For Column Set fields that do not have corresponding properties on the entity being returned, new dynamic properties will be returned under RelatedAttributes and/or RelatedAggregates properties accordingly. Want to control auth yourself? This usually occurs because of a missing or malformed parameter. To help you track your APIs, Apideck visualises your usage through graphs and history logs. The date/time the JourneyMilestone record was created. Check out the OSS libraries we're working on and supporting. The Journey associated with this progress. Login to view your personalized documentation. The date/time the SegmentColumnSet record was created. The filter is evaluated for each resource in the result set and only those resources that evaluated to true for the given filter will be included in the result. The number of choices available to answer a survey. Accessed dynamically through Segment Column Set selection. ISO 8601 formatted string. To create a new Api Key, navigate to the Admin > Api Keys page. The count property will reside at the same level as the values property and will have a key of @odata.count. Most notably, anything specified via $filter will affect the count returned. ISO 8601 formatted string. The JourneyMilestone associated with this progress. The Segment must belong to the entity in the request. The calculated number of Active Contacts. The number of months until the survey reoccurs. Pre-made building blocks to get started with Apideck. The $expand option allows related resources to be included in the response inline. The $top option requests the number of resources to be queried in the collection. True if the Contact has chosen to unsubscribe from marketing emails. by name) but is significantly less accurate. The new features, being new endpoints or properties on existing endpoints, will be exposed in an additive fashion. Not into REST APIs? When using a Column Set, the properties returned in the response are dynamic and determined by the fields configured on the Column Set in the ChurnZero application. The SegmentColumnSet must belong to the authorized API User or have a configured ShareType of 'All' or 'Domain'. Note: this can be found in the top left of your contact or account page (not the ID in the url). 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.



Sitemap 20