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. The number of months until the survey reoccurs. Our API reference is generated from our OpenAPI spec. The date/time this Account started. Read the announcement, Broederminstraat 9, 2018 Antwerp, Belgium. The set of predefined reasons for failing the Journey. ISO 8601 formatted string. The number of requests under the soft max will execute at normal speed. We don't receive detailed errors from Churnzero, such as checking whether an When you create an account, you have the option to enter an External ID. ChurnZero needs to know that every time a company is mapped, the ID is in the same place. To use the custom table API, you must first create the custom table within Churnzero. 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 date/time the Task record was last modified. 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. Note: this can be found in the top left of your contact or account page (not the ID in the url). Two thresholds are tracked per minute. Documentation based off of the ChurnZero demo customer, MarketingPony. Not sure how Apideck can help your business? The page size for all collection requests is 100 results. GET /ChurnScoreFactorCalculation({Id})/Account, GET /ChurnScoreFactorCalculation({Id})/ChurnScore, GET /ChurnScoreFactorCalculation({Id})/ChurnScoreFactor. The Id of the Account associated with this Contact. This is the template that is used to create an Achievement instance for Accounts that enter the JourneyMilestone. ISO 8601 formatted string. The $filter option allows limiting of resources in the collection that is returned for the requested URL. There is no default mapping for this. The date the Account ended the Journey. The date/time the JourneyMilestoneAchievement record was last modified. 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. True if the Contact has chosen to unsubscribe from marketing emails. The Total Contract Amount of this Account. The number of days since this Account's start date. Map my projects from Company A using the External ID in this mechanism: '[External ID] Company A'. All resources of the collection can be addressed by using $skip as defined in the provided @odata.nextLink property. The date/time the Contact record was created. Survey definition available in ChurnZero. Accessed dynamically through Segment Column Set selection. The Account associated with this progress. A simple operand would deal with just one property The date/time the JourneyMilestone record was created. (Announcement, Email). The date/time the JourneyProgress record was last modified. The follow up question associated with this survey response. Churn Score Factor Calculation available in ChurnZero. All filters used in conjunction with Segments must use the 'and' operator. Accessed dynamically through Segment Column Set selection. Within Teamwork, you can use your companies to map their associated projects and tasks to accounts and contacts 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 date/time for this Account's next renewal. The #1 integration marketplace builder for SaaS companies. This may be null and is mutually exclusive with JourneyMilestoneAchievementId. You can find the custom fields created for your Churnzero workspace in Admin > Custom Fields then navigating to either the contact or account table. Journey Milestone Step progress of Accounts. Volume packaging is available on request. The Id that this Task is linked to in an external source. Inspect all the traffic going to the Churnzero API. ISO 8601 formatted string. ISO 8601 formatted string. Given a username of someuser and a password of sup3rS3cr37! 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. +100 Tools to extend your remote stack, ranging from Collaborative Design, Video Conferencing to Virtual Offices. True if the Account has failed the JourneyMilestone. Please make sure that the account exists in Churnzero already. The accessibility of the SegmentColumnSet. Errors will follow the standard OData error format as shown below. ISO 8601 formatted string. We offer a GraphQL API that integrates every Unified API. The date/time the UserAccount record was created. The JourneyMilestone that this JourneyMilestoneTask belongs too.
The date the Account entered the journey. The JourneyMilestone associated with this progress. True if the User Account owns Accounts in ChurnZero. by name) but is significantly less accurate. A set of state-the-art unified APIs to build native integrations with other SaaS providers. The Id of the Account associated with this Event. True if the Task Priority is high priority. A valid authentication token was not provided with the request, so the API could not associate a user with the request. The source of the survey response. This is the template that is used to create a Task instance for Accounts that enter the JourneyMilestone. ISO 8601 formatted string. For example, an Account references a UserAccount. The date/time the JourneyMilestone record was last modified. The Id that this User Account is linked to in an external source. HTTP Basic Authentication can be used with the ChurnZero REST API. ISO 8601 formatted string. The segment filter operator must be 'eq'. ISO 8601 formatted string. When viewing this newly created account, you can see the External ID (e.g. The description for the JourneyMilestone. For example, if Zendesk Tickets are synced into ChurnZero, a new API endpoint for those tickets will be exposed and documented below. able to provide detailed logging.
The number of Total Events for the Event Type. ISO 8601 formatted string. The date the next reminder will occur. Tracking 15,000+ APIs and SaaS products. In the setup screen, enter in your host name and API token.
The entity must support Segments (see above). The number of days this Account is over the expectation for the JourneyMilestone. These properties are automatically added to $select/$expand options where applicable. 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. Connection issues with your data warehouse? Additionally, there is a limit of 5 and or or operators in a single filter expression.
The User associated to an Account Role. The date/time the Account record was last modified. ISO 8601 formatted string. The ID of the Account associated with this survey response. ISO 8601 formatted string. The ID of the Churn Score associated with this calculation. Port OpenAPI Specs to Postman Collections, and inject test suite. 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. ISO 8601 formatted string.
ISO 8601 formatted string. The ChurnZero REST API is an add-on feature that must be enabled and correctly configured with the necessary permissions to be used. All Accounts with all related resources embedded inline. Instead, it will be incumbent on the caller to continue to increase $skip by the desired amount until an empty result set is observed. GET /JourneyProgress({Id})/JourneyInstance, GET /JourneyMilestoneProgress({Id})/Account, GET /JourneyMilestoneProgress({Id})/Journey, GET /JourneyMilestoneProgress({Id})/JourneyInstance, GET /JourneyMilestoneProgress({Id})/JourneyMilestone. At some later point, if new fields are imported from those Zendesk Tickets they will become available on the exposed endpoint and documented below. The data type of the follow up answer. 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. Want to control auth yourself? If a different page size is desired, the $top operation can be used in conjunction with $skip. The Minimum Event Date for the Event Type. This may be null and is mutually exclusive with JourneyMilestoneTaskId. Records can be matched from your source to your Churnzero workspace by your Churnzero Contact / Account ID. The type of answer associated with the question. The start date of this JourneyInstance ISO 8601 formatted string. Churnzero requires that you map at least one default (standard) field in order There is an additional field when syncing contacts, which is the column that contains the external account ID in your query results. Survey response collected in ChurnZero for a Survey. When you view one of the companies in ChurnZero, the associated projects will show up. Accessed dynamically through Segment Column Set selection. The ID that this Account is linked to in an external source. Easily showcase integrations, partners, and apps to your customers. Accessed dynamically through Segment Column Set selection. The overall status associated with the Task or Achievement represented by this progress. Visit the Developers Guide to see more examples and to begin using the API. After you authorize the connection, you will be presented with a summary of the connection information, along with an option to deauthorize if you wish. ISO 8601 formatted string. The Contact's combined First Name, Last Name, and Email if available. The number of days the Account is past the completion date. The number of days this Account has left for the Journey according to the epectation. ISO 8601 formatted string. ISO 8601 formatted string. ISO 8601 formatted string. The number of days an Account is expected to be in the Journey, True if this Journey is configured for sharing. The Id that this Contact is linked to in an external source. Helping you discover the best APIs and SaaS products to integrate with.
The $select option allows resource results to only include the specified properties. ISO 8601 formatted string. We're here to help with any questions. The close date of the Task. Query parameters can control the amount and order of the data returned for the resource identified by the URL. If you see something that's missing from our app, let us know and we'll work with you to build it! The higher-bounds value of the grading scale. ISO 8601 formatted string. The date/time the Journey record was last modified. The status of the survey. 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. The JourneyMilestoneTask associated with this progress. ISO 8601 formatted string. The date/time the Contact record was last modified. Open-source software is part of our core. of the company name, as long as it is consistent throughout. To help you track your APIs, Apideck visualises your usage through graphs and history logs. True if the User Account can log into ChurnZero. All Accounts with the related UserAccount embedded inline. These are limited to Account, Contact, Event, and Custom Table entities and can be discovered by making a request to the SegmentColumnSet endpoint. GET /ChurnScoreCalculation({Id})/ChurnScore. The Id of the Account associated with this Task. The date/time the JourneyMilestoneProgress record was created. 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. The Id of the Churn Score associated with this Churn Score Factor. Accessed dynamically through Segment Column Set selection. The number of Distinct Contacts for the Event Type. The date/time the JourneyMilestoneStepProgress record was last modified. The calculated number of Active Contacts. 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. Sending the request again will succeed. ISO 8601 formatted string. Human-friendly JSON Schema validation for APIs. ISO 8601 formatted string. The preferred means of relating a record back to an account is through an ID, specifically the account's External ID. Available as REST and GraphQL APIs. 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. Wrap existing Churnzero API calls with the Apideck Proxy endpoint. When building out the filter operands it may be necessary to URL encode the operand. Our Developer-friendly plan includes 20,000 API calls per month and is designed to allow a wide range of use cases. String matching is possible (e.g. The number of Contacts associated with this Account. *We measure API calls per downstream API call to the API provider (e.g., Salesforce, Pipedrive). Easy to integrate within your current codebase. Every 15 minutes, the sync will pull in new projects and tasks, as well as search through existing projects and tasks in order to match them to contacts and accounts. ISO 8601 formatted string. 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. The date that the response was created. JourneyMilestoneAchievement definition available in ChurnZero.
multiple resources, they can all be included by referencing the properties with a comma separated list. To successfully make a request you will need to pass your ChurnZero username and an Api Key associated with your user as an authorization header with each request. The Maximum Event Date for the Event Type. The intent of the soft and hard max thresholds is to coerce an API client into compliance rather than go to an immediate hard error. The day this Journey was evaluated for the Account. Any number of requests greater than the soft max but less than the hard max will execute with a progressively longer delay. True if the Account has failed the journey. Inspect all the traffic coming and going to the Churnzero API and optionally inject tokens at runtime. The $skip option requests the number of resources that are to be skipped and not included in the queried collection. The number of days this Account has been in the Journey. The date/time the JourneyMilestoneTask record was created. Using the provided @odata.nextLink the next page can be retrieved and a new newLink will be provided. The ID of the Contact associated with this survey response. ISO 8601 formatted string. The Account's status in the JourneyMilestone. True if the Account has completed the journey. Using the ChurnZero Integration with Teamwork Desk, Your hostname is your Teamwork site URL without the https://. ISO 8601 formatted string. This represents the progress of the associated Task or Achievement from the perspective of the Journey. Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist. The Id of the ChurnScore that is marked as primary for this Account. GET /JourneyMilestoneTask({Id})/JourneyMilestone. The top 10 Accounts ordered by ObjectLastModifiedDate. to sync properly. The ID of the Survey associated with this survey response. The name of the JourneyMilestoneAchievement. ISO 8601 formatted string. You have set up the Teamwork integration. They are set individually so that access to certain Entities can be controlled on a per-group basis. The count property will reside at the same level as the values property and will have a key of @odata.count. To find the setup key, navigate to Admin > Application Keys > New App Key and create a new key with the name of your choice. ISO 8601 formatted string. In the case of using $top, there will no provided @odata.nextLink property in the response. You have exceeded one of the enforced rate limits in the API. $select can be used in conjunction with $expand to tailor the payload for related resources that are inlined with the response. In a given filter operation, Visit the documentation and API reference to get a complete overview of the endpoints and APIs we offer. The authentication and request syntax was valid but the server is refusing to complete the request. The Event aggregates related to an Entity. The top 10 Accounts ordered by ObjectLastModifiedDate, but skip 30 Accounts. The number of days this Account has been in the JourneyMilestone. ISO 8601 formatted string. The date/time the JourneyMilestoneAchievement record was created. The following tables list some common data types supported by the ChurnZero REST API. The Journey related to an Account. ISO 8601 formatted string. The date/time the SegmentColumnSet record was created. The day this JourneyMilestone was evaluated for the Account. The date/time the JourneyMilestoneStepProgress record was created. JourneyMilestone definition available in ChurnZero. The ID of the Churn Score Factor associated with this calculation. The date/time the SegmentColumnSet record was last modified. See the documentation on rate limiting for more information. The Id of the Journey associated with the Account. 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 Journey associated with this progress. For example, Email eq '[emailprotected]' should be encoded as Email eq 'user%[emailprotected]' Apideck offers native SDKs in several popular programming languages and frameworks. The Developer Tools user permission is required to be set on the User Account configured to make requests. The date/time this Account ended. Churn Score Factor available in ChurnZero. The schema definitions for each object requested or returned from ChurnZero's REST API. ISO 8601 formatted string. The score that was given for the survey response. Delivering the best-in-class products to boost your platform strategy. Therefore, we are not If the desired filter cannot be constructed with the available simple or complex operands, then ChurnZero Segments 1245) noted at the bottom. This is useful to tailor response payloads to reduce the amount of data being returned. If a particular resource is related to Login to view your personalized documentation. Once that is done, all projects associated with that company in Teamwork will be mapped to their account in ChurnZero. True if the calculation is deemed active. Projects and tasks themselves cannot interact with plays, journeys, NPS campaigns, or churn scores. The end of the collection will be signified by a response with an empty result set. The $count option indicates that the collection response should include the overall count of resources in the collection. The number of days an Account is expected to be in the JourneyMilestone. The Id of the Contact associated with this Task. Not into REST APIs? Our team is relentlessly focused on your success. Tracking 3,200+ open banking and PSD2 APIs from challenger banks, TPPs, and financial institutions. The date the Account entered the JourneyMilestone. The number of days this Account is over the expectation for the Journey. 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. 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 number of days this Account has left for the JourneyMilestone according to the epectation. Track PII across all API traffic. (Text, YesNo, Currency, Date, Number, Percent, SingleSelect, MultiSelect). 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 Journey that this JourneyMilestone belongs too. ISO 8601 formatted string. The Attributes related to an Account/Contact. The comment that was given for the survey response. Accessed dynamically through Segment Column Set selection. The date/time the Journey record was created. Log in to your ChurnZero Production account and go to. The date/time the UserAccount record was last modified. Check out the OSS libraries we're working on and supporting. 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. Inject tokens at runtime. Accessed dynamically through Segment Column Set selection. True if the Task Priority is the default. The Aggregates related to an Account/Contact. If you use primarily custom fields, make sure to also map at The date/time for the Parent Account's next renewal. 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 entity associated with this SegmentColumnSet. ISO 8601 formatted string. The JourneyInstance assocated with this progress. Each account in ChurnZero has an external ID. 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.
The underlying model/schema has changed. Most notably, anything specified via $filter will affect the count returned. The number of choices available to answer a survey. You have the option to add this ID to the beginning, end, etc. The $top option requests the number of resources to be queried in the collection. or possibly Email%20eq%20%27user%2B1%40domain.com%27. such as BillingAddressState eq 'VA', while a complex operand combines simple operands with the and or or operartors. The new features, being new endpoints or properties on existing endpoints, will be exposed in an additive fashion. The JourneyInstance in ChurnZero represents a single progression of an Account through a Journey. Since Teamwork does not support custom fields on any of these entities so ChurnZero will pull the standard fields for each entity. We're ready to jump on a call to help unblock you. This is a dynamic API that will adjust as customizations are made to your ChurnZero instance and as new features are developed for ChurnZero. A GPT-3 directory covering 150+ apps, use-cases, examples, and demos. Unsupported destination objects or modes. For fields to properly be inserted into a custom table from Hightouch, they The Role related to an Account.
Accessed dynamically through Segment Column Set selection. ISO 8601 formatted string. True if the Account has failed the Journey. The Survey Scores related to an Account. must first be created within Churnzero on the "Custom Fields" page. Accessed dynamically through Segment Column Set selection. +100 Startup programs to help you save on your SaaS spend. The date the Account ended the JourneyMilestone. The first threshold is a soft max and the second threshold is a hard max. Usually caused by a race condition. All Accounts with the related UserAccount and PrimaryChurnScore embedded inline. least one default (standard) field. Built for API consumers. account ID referenced or a custom field exists or not. Requests above the hard max will result in a 429 Too Many Requests response. The ID of the Account associated with this calculation. The Account that this JourneyInstance belongs too. The * option for $expand is a special option that means include all referenced entities. must be used. ISO 8601 formatted string. The JourneyMilestone that this JourneyMilestoneAchievement belongs too. To create a new Api Key, navigate to the Admin > Api Keys page. The Event Type associated to an Event aggregate. Confusing API responses from destination systems? The lower-bounds value of the grading scale. The date/time the Task record was created. 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. We are now officially SOC 2 Type 2 compliant! True if the Account has completed the JourneyMilestone. For custom fields, please use the CZ API Name as the name of the destination field in Hightouch. The JourneyInstance assocated with this progress. Surveys related to a Contact. The Contact's full name. GET /Account(AccountExternalId='{AccountExternalId}'), GET /Contact(AccountExternalId='{AccountExternalId}',ContactExternalId='{ContactExternalId}'), None (limited to the Segment owner and global Segments), None (limited to the SegmentColumnSet Owner and ShareTypes of 'All' or 'Domain'). This is done at the account and/or contact level. We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data. The SegmentColumnSet must belong to the entity in the request. This usually occurs because of a missing or malformed parameter.
The date the Account entered the journey. The JourneyMilestone associated with this progress. True if the User Account owns Accounts in ChurnZero. by name) but is significantly less accurate. A set of state-the-art unified APIs to build native integrations with other SaaS providers. The Id of the Account associated with this Event. True if the Task Priority is high priority. A valid authentication token was not provided with the request, so the API could not associate a user with the request. The source of the survey response. This is the template that is used to create a Task instance for Accounts that enter the JourneyMilestone. ISO 8601 formatted string. For example, an Account references a UserAccount. The date/time the JourneyMilestone record was last modified. The Id that this User Account is linked to in an external source. HTTP Basic Authentication can be used with the ChurnZero REST API. ISO 8601 formatted string. The segment filter operator must be 'eq'. ISO 8601 formatted string. When viewing this newly created account, you can see the External ID (e.g. The description for the JourneyMilestone. For example, if Zendesk Tickets are synced into ChurnZero, a new API endpoint for those tickets will be exposed and documented below. able to provide detailed logging.
The number of Total Events for the Event Type. ISO 8601 formatted string. The date the next reminder will occur. Tracking 15,000+ APIs and SaaS products. In the setup screen, enter in your host name and API token.
The entity must support Segments (see above). The number of days this Account is over the expectation for the JourneyMilestone. These properties are automatically added to $select/$expand options where applicable. 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. Connection issues with your data warehouse? Additionally, there is a limit of 5 and or or operators in a single filter expression.
The User associated to an Account Role. The date/time the Account record was last modified. ISO 8601 formatted string. The ID of the Account associated with this survey response. ISO 8601 formatted string. The ID of the Churn Score associated with this calculation. Port OpenAPI Specs to Postman Collections, and inject test suite. 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. ISO 8601 formatted string.
ISO 8601 formatted string. The ChurnZero REST API is an add-on feature that must be enabled and correctly configured with the necessary permissions to be used. All Accounts with all related resources embedded inline. Instead, it will be incumbent on the caller to continue to increase $skip by the desired amount until an empty result set is observed. GET /JourneyProgress({Id})/JourneyInstance, GET /JourneyMilestoneProgress({Id})/Account, GET /JourneyMilestoneProgress({Id})/Journey, GET /JourneyMilestoneProgress({Id})/JourneyInstance, GET /JourneyMilestoneProgress({Id})/JourneyMilestone. At some later point, if new fields are imported from those Zendesk Tickets they will become available on the exposed endpoint and documented below. The data type of the follow up answer. 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. Want to control auth yourself? If a different page size is desired, the $top operation can be used in conjunction with $skip. The Minimum Event Date for the Event Type. This may be null and is mutually exclusive with JourneyMilestoneTaskId. Records can be matched from your source to your Churnzero workspace by your Churnzero Contact / Account ID. The type of answer associated with the question. The start date of this JourneyInstance ISO 8601 formatted string. Churnzero requires that you map at least one default (standard) field in order There is an additional field when syncing contacts, which is the column that contains the external account ID in your query results. Survey response collected in ChurnZero for a Survey. When you view one of the companies in ChurnZero, the associated projects will show up. Accessed dynamically through Segment Column Set selection. The ID that this Account is linked to in an external source. Easily showcase integrations, partners, and apps to your customers. Accessed dynamically through Segment Column Set selection. The overall status associated with the Task or Achievement represented by this progress. Visit the Developers Guide to see more examples and to begin using the API. After you authorize the connection, you will be presented with a summary of the connection information, along with an option to deauthorize if you wish. ISO 8601 formatted string. The Contact's combined First Name, Last Name, and Email if available. The number of days the Account is past the completion date. The number of days this Account has left for the Journey according to the epectation. ISO 8601 formatted string. ISO 8601 formatted string. ISO 8601 formatted string. The number of days an Account is expected to be in the Journey, True if this Journey is configured for sharing. The Id that this Contact is linked to in an external source. Helping you discover the best APIs and SaaS products to integrate with.
The $select option allows resource results to only include the specified properties. ISO 8601 formatted string. We're here to help with any questions. The close date of the Task. Query parameters can control the amount and order of the data returned for the resource identified by the URL. If you see something that's missing from our app, let us know and we'll work with you to build it! The higher-bounds value of the grading scale. ISO 8601 formatted string. The date/time the Journey record was last modified. The status of the survey. 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. The JourneyMilestoneTask associated with this progress. ISO 8601 formatted string. The date/time the Contact record was last modified. Open-source software is part of our core. of the company name, as long as it is consistent throughout. To help you track your APIs, Apideck visualises your usage through graphs and history logs. True if the User Account can log into ChurnZero. All Accounts with the related UserAccount embedded inline. These are limited to Account, Contact, Event, and Custom Table entities and can be discovered by making a request to the SegmentColumnSet endpoint. GET /ChurnScoreCalculation({Id})/ChurnScore. The Id of the Account associated with this Task. The date/time the JourneyMilestoneProgress record was created. 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. The Id of the Churn Score associated with this Churn Score Factor. Accessed dynamically through Segment Column Set selection. The number of Distinct Contacts for the Event Type. The date/time the JourneyMilestoneStepProgress record was last modified. The calculated number of Active Contacts. 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. Sending the request again will succeed. ISO 8601 formatted string. Human-friendly JSON Schema validation for APIs. ISO 8601 formatted string. The preferred means of relating a record back to an account is through an ID, specifically the account's External ID. Available as REST and GraphQL APIs. 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. Wrap existing Churnzero API calls with the Apideck Proxy endpoint. When building out the filter operands it may be necessary to URL encode the operand. Our Developer-friendly plan includes 20,000 API calls per month and is designed to allow a wide range of use cases. String matching is possible (e.g. The number of Contacts associated with this Account. *We measure API calls per downstream API call to the API provider (e.g., Salesforce, Pipedrive). Easy to integrate within your current codebase. Every 15 minutes, the sync will pull in new projects and tasks, as well as search through existing projects and tasks in order to match them to contacts and accounts. ISO 8601 formatted string. 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. The date that the response was created. JourneyMilestoneAchievement definition available in ChurnZero.
multiple resources, they can all be included by referencing the properties with a comma separated list. To successfully make a request you will need to pass your ChurnZero username and an Api Key associated with your user as an authorization header with each request. The Maximum Event Date for the Event Type. The intent of the soft and hard max thresholds is to coerce an API client into compliance rather than go to an immediate hard error. The day this Journey was evaluated for the Account. Any number of requests greater than the soft max but less than the hard max will execute with a progressively longer delay. True if the Account has failed the journey. Inspect all the traffic coming and going to the Churnzero API and optionally inject tokens at runtime. The $skip option requests the number of resources that are to be skipped and not included in the queried collection. The number of days this Account has been in the Journey. The date/time the JourneyMilestoneTask record was created. Using the provided @odata.nextLink the next page can be retrieved and a new newLink will be provided. The ID of the Contact associated with this survey response. ISO 8601 formatted string. The Account's status in the JourneyMilestone. True if the Account has completed the journey. Using the ChurnZero Integration with Teamwork Desk, Your hostname is your Teamwork site URL without the https://. ISO 8601 formatted string. This represents the progress of the associated Task or Achievement from the perspective of the Journey. Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist. The Id of the ChurnScore that is marked as primary for this Account. GET /JourneyMilestoneTask({Id})/JourneyMilestone. The top 10 Accounts ordered by ObjectLastModifiedDate. to sync properly. The ID of the Survey associated with this survey response. The name of the JourneyMilestoneAchievement. ISO 8601 formatted string. You have set up the Teamwork integration. They are set individually so that access to certain Entities can be controlled on a per-group basis. The count property will reside at the same level as the values property and will have a key of @odata.count. To find the setup key, navigate to Admin > Application Keys > New App Key and create a new key with the name of your choice. ISO 8601 formatted string. In the case of using $top, there will no provided @odata.nextLink property in the response. You have exceeded one of the enforced rate limits in the API. $select can be used in conjunction with $expand to tailor the payload for related resources that are inlined with the response. In a given filter operation, Visit the documentation and API reference to get a complete overview of the endpoints and APIs we offer. The authentication and request syntax was valid but the server is refusing to complete the request. The Event aggregates related to an Entity. The top 10 Accounts ordered by ObjectLastModifiedDate, but skip 30 Accounts. The number of days this Account has been in the JourneyMilestone. ISO 8601 formatted string. The date/time the JourneyMilestoneAchievement record was created. The following tables list some common data types supported by the ChurnZero REST API. The Journey related to an Account. ISO 8601 formatted string. The date/time the SegmentColumnSet record was created. The day this JourneyMilestone was evaluated for the Account. The date/time the JourneyMilestoneStepProgress record was created. JourneyMilestone definition available in ChurnZero. The ID of the Churn Score Factor associated with this calculation. The date/time the SegmentColumnSet record was last modified. See the documentation on rate limiting for more information. The Id of the Journey associated with the Account. 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 Journey associated with this progress. For example, Email eq '[emailprotected]' should be encoded as Email eq 'user%[emailprotected]' Apideck offers native SDKs in several popular programming languages and frameworks. The Developer Tools user permission is required to be set on the User Account configured to make requests. The date/time this Account ended. Churn Score Factor available in ChurnZero. The schema definitions for each object requested or returned from ChurnZero's REST API. ISO 8601 formatted string. The score that was given for the survey response. Delivering the best-in-class products to boost your platform strategy. Therefore, we are not If the desired filter cannot be constructed with the available simple or complex operands, then ChurnZero Segments 1245) noted at the bottom. This is useful to tailor response payloads to reduce the amount of data being returned. If a particular resource is related to Login to view your personalized documentation. Once that is done, all projects associated with that company in Teamwork will be mapped to their account in ChurnZero. True if the calculation is deemed active. Projects and tasks themselves cannot interact with plays, journeys, NPS campaigns, or churn scores. The end of the collection will be signified by a response with an empty result set. The $count option indicates that the collection response should include the overall count of resources in the collection. The number of days an Account is expected to be in the JourneyMilestone. The Id of the Contact associated with this Task. Not into REST APIs? Our team is relentlessly focused on your success. Tracking 3,200+ open banking and PSD2 APIs from challenger banks, TPPs, and financial institutions. The date the Account entered the JourneyMilestone. The number of days this Account is over the expectation for the Journey. 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. 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 number of days this Account has left for the JourneyMilestone according to the epectation. Track PII across all API traffic. (Text, YesNo, Currency, Date, Number, Percent, SingleSelect, MultiSelect). 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 Journey that this JourneyMilestone belongs too. ISO 8601 formatted string. The Attributes related to an Account/Contact. The comment that was given for the survey response. Accessed dynamically through Segment Column Set selection. The date/time the Journey record was created. Log in to your ChurnZero Production account and go to. The date/time the UserAccount record was last modified. Check out the OSS libraries we're working on and supporting. 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. Inject tokens at runtime. Accessed dynamically through Segment Column Set selection. True if the Task Priority is the default. The Aggregates related to an Account/Contact. If you use primarily custom fields, make sure to also map at The date/time for the Parent Account's next renewal. When building a request using Basic Authentication, make sure you add the Authorization header with a value of Basic
The underlying model/schema has changed. Most notably, anything specified via $filter will affect the count returned. The number of choices available to answer a survey. You have the option to add this ID to the beginning, end, etc. The $top option requests the number of resources to be queried in the collection. or possibly Email%20eq%20%27user%2B1%40domain.com%27. such as BillingAddressState eq 'VA', while a complex operand combines simple operands with the and or or operartors. The new features, being new endpoints or properties on existing endpoints, will be exposed in an additive fashion. The JourneyInstance in ChurnZero represents a single progression of an Account through a Journey. Since Teamwork does not support custom fields on any of these entities so ChurnZero will pull the standard fields for each entity. We're ready to jump on a call to help unblock you. This is a dynamic API that will adjust as customizations are made to your ChurnZero instance and as new features are developed for ChurnZero. A GPT-3 directory covering 150+ apps, use-cases, examples, and demos. Unsupported destination objects or modes. For fields to properly be inserted into a custom table from Hightouch, they The Role related to an Account.
Accessed dynamically through Segment Column Set selection. ISO 8601 formatted string. True if the Account has failed the Journey. The Survey Scores related to an Account. must first be created within Churnzero on the "Custom Fields" page. Accessed dynamically through Segment Column Set selection. +100 Startup programs to help you save on your SaaS spend. The date the Account ended the JourneyMilestone. The first threshold is a soft max and the second threshold is a hard max. Usually caused by a race condition. All Accounts with the related UserAccount and PrimaryChurnScore embedded inline. least one default (standard) field. Built for API consumers. account ID referenced or a custom field exists or not. Requests above the hard max will result in a 429 Too Many Requests response. The ID of the Account associated with this calculation. The Account that this JourneyInstance belongs too. The * option for $expand is a special option that means include all referenced entities. must be used. ISO 8601 formatted string. The JourneyMilestone that this JourneyMilestoneAchievement belongs too. To create a new Api Key, navigate to the Admin > Api Keys page. The Event Type associated to an Event aggregate. Confusing API responses from destination systems? The lower-bounds value of the grading scale. The date/time the Task record was created. 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. We are now officially SOC 2 Type 2 compliant! True if the Account has completed the JourneyMilestone. For custom fields, please use the CZ API Name as the name of the destination field in Hightouch. The JourneyInstance assocated with this progress. Surveys related to a Contact. The Contact's full name. GET /Account(AccountExternalId='{AccountExternalId}'), GET /Contact(AccountExternalId='{AccountExternalId}',ContactExternalId='{ContactExternalId}'), None (limited to the Segment owner and global Segments), None (limited to the SegmentColumnSet Owner and ShareTypes of 'All' or 'Domain'). This is done at the account and/or contact level. We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data. The SegmentColumnSet must belong to the entity in the request. This usually occurs because of a missing or malformed parameter.