GrowthScore provides a Web API that allows customers to retrieve information about their account such as Contacts, Feedback, Testimonials, Reviews, Referrals and other operations. This API is not RESTful since for most calls both GET and POST HTTP verbs can be used interchangeably, and other verbs are not supported.
\nGrowthScore API is accessed via the https://api.growthscore.io domain.
\nEvery API request you make API must be authenticated by including an auth-gskey Header with your API Key.
\nAll requests to the API must be made via HTTPS. It is a best practice to include the Content-Type: application/json header in all of your requests.
\nThe API is completely RESTful and accepts GET and POST requests, depending on the resource.
\nThere are three HTTP status classes you are expected to encounter from time-to-time.
\n2XX Responses\n2XX responses indicate a successfully completed request.
\n4XX series - Request Error\n4XX errors are related to incorrect requests. These requests should be reviewed and corrected before retrying.
\n5XX series - System Error\n5XX errors indicate the GrowthScore system cannot fulfil the request. This might be due to temporary issues with GrowthScore's system or undetermined internet vagaries. Given the nature of HTTP-over-internet communications, 500 errors are inevitable and we strongly recommend implementing an exponential back-off retry mechanism that retries order requests when a 500 series error is received.
\n\nAPI Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"storeid\":\"xzquu1\",\n\t\"emailid\":\"xy1@gmail.com\",\n\t\"firstname\":\"Firstclass\",\n\t\"lastname\":\"Xmen\",\n\t\"attributes\":{\"subscriptionq\":\"Gold\", \"usertypeq\":2, \"revenue\":2000.45, \"premiumq\":true}\n}"},"url":"https://api.growthscore.io/v1/createcontact","description":"This API to register/update user with GrowthScore
\nContact Model
\n| Parameter | Description |
| emailid * | Email Id |
| storeid | External Id |
| firstname | First Name |
| lastname | Last Name |
| signupdate | Signup Date (Eg: 2016-10-20 23:55:45) |
| source | Source of Input for Identification |
| nps | Net Promoter Score |
| lastnpsdate | Last NPS Date |
| lastsurveydate | Last Survey Date |
| csat | true - If user gives a good rating in CSAT Survey |
| attributes | Other user attributes if any |
| enablenps | Enable NPS (true/false) |
| enablereview | Enable Reviews (true/false) |
| enabletestimonial | Enable Testimonials (true/false) |
Response codes received in the response parameter statuscode are explained below.
\n| 2 | Contact added |
| 3 | Contact updated |
| 4 | Missing emailid. Email is mandatory to save contact |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"page\":1,\n\t\"storeid\":null,\n\t\"emailid\":null,\n\t\"nps\":null\n}"},"url":"https://api.growthscore.io/v1/contacts","description":"List all contacts. Filter the results using below parameters
\n| Parameter | Description |
| page | Page number. API limits to 50 records at once |
| emailid | Email Id |
| storeid | External Id |
| nps | Net Promoter Score |
Response codes received in the response parameter statuscode are explained below.
\n| 1 | Success |
| 5 | Search returned 0 results |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"fromdate\":null,\n\t\"todate\":null,\n\t\"page\":3,\n\t\"storeid\":null,\n\t\"emailid\":null,\n\t\"nps\":null\n}"},"url":"https://api.growthscore.io/v1/feedback","description":"List feedback received from NPS Survey. Filter the results using below parameters
\n| Parameter | Description |
| page | Page number. API limits to 50 records at once |
| emailid | Email Id |
| storeid | External Id |
| nps | Net Promoter Score |
| fromdate | Refers to Contact Created Date (Eg: 2016-10-20 23:55:45) |
| todate | Refers to Contact Created Date (Eg: 2016-10-30 23:55:45) |
Response codes received in the response parameter statuscode are explained below.
\n| 1 | Success |
| 5 | Search returned 0 results |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"storeid\":\"xzquu1\",\n\t\"emailid\":\"xy1@gmail.com\",\n\t\"firstname\":\"Firstclass\",\n\t\"lastname\":\"Xmen\",\n\t\"attributes\":{\"subscriptionq\":\"Gold\", \"usertypeq\":2, \"revenue\":2000.45, \"premiumq\":true}\n}"},"url":"https://api.growthscore.io/v1/sendnpssurvey","description":"This endpoint allows you to send survey immediately to the contact specified after checking the eligibility conditions.
\nAPI accepts Contact Model as input.
\nResponse codes received in the response parameter statuscode are explained below.
\n| 1 | Survey mail scheduled |
| 4 | Missing emailid. Email is mandatory |
| 6 | NPS isn't enabled |
| 7 | Recurring email survey isn't configured |
| 8 | Didn't meet eligibility criteria (How often should we send the survey) |
| 9 | Didn't meet eligibility criteria (Survey Throttle) |
| 10 | Didn't meet eligibility criteria (When to survey newly added contacts) |
| 11 | Failed to send survey mail |
| 21 | A survey mail is already scheduled for the user |
| 22 | Exceeded monthly limit or Not a valid Susbcription |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"storeid\":\"xzquu1\",\n\t\"emailid\":\"xy1@gmail.com\",\n\t\"firstname\":\"Firstclass\",\n\t\"lastname\":\"Xmen\",\n\t\"attributes\":{\"subscriptionq\":\"Gold\", \"usertypeq\":2, \"revenue\":2000.45, \"premiumq\":true},\n\t\"reviewplatform\": \"G2Crowd\"\n}"},"url":"https://api.growthscore.io/v1/askreview","description":"This endpoint allows you to ask the contact for a review immediately after checking the eligibility conditions.
\nAPI accepts parmeters from the Contact Model as input. Along with you can specify the review platform you would like to request the user.
\nreviewplatform - G2Crowd, Capterra, GetApp, TrustRadius, Trustpilot, Quickbooks, Siftery, SalesforceAppExchange, Mailchimp, Shopify, Zendesk, Wordpress.
\nResponse codes received in the response parameter statuscode are explained below.
\n| 1 | Triggered outreach for review |
| 4 | Missing emailid. Email is mandatory |
| 12 | Reviews isn't enabled |
| 13 | Review Platform isn't configured |
| 14 | Contact completed all configured Reviews |
| 15 | Contact didn't meet the Mail Throttle |
| 16 | Failed to trigger outreach for review |
| 21 | An outreach is already scheduled for the user |
| 22 | Not a valid Susbcription |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"storeid\":\"xzquu1\",\n\t\"emailid\":\"xy1@gmail.com\",\n\t\"firstname\":\"Firstclass\",\n\t\"lastname\":\"Xmen\",\n\t\"attributes\":{\"subscriptionq\":\"Gold\", \"usertypeq\":2, \"revenue\":2000.45, \"premiumq\":true}\n}"},"url":"https://api.growthscore.io/v1/asktestimonial","description":"This endpoint allows you to ask the contact for a testimonial immediately after checking the eligibility conditions.
\nAPI accepts parmeters from the Contact Model as input.
\nResponse codes received in the response parameter statuscode are explained below.
\n| 1 | Triggered outreach for testimonial |
| 4 | Missing emailid. Email is mandatory |
| 17 | Testimonials isn't enabled |
| 18 | Contact completed Testimonial |
| 19 | Contact didn't meet the Mail Throttle |
| 20 | Failed to trigger outreach for testimonial |
| 21 | An outreach is already scheduled for the user |
| 22 | Not a valid Susbcription |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"page\": 1,\n\t\"fromdate\":null,\n\t\"todate\":null,\n\t\"reviewplatform\":\"G2Crowd\"\n}"},"url":"https://api.growthscore.io/v1/reviews","description":"List reviews received from happy users. Filter the results using below parameters
\n| Parameter | Description |
| page | Page number. API limits to 50 records at once |
| reviewplatform | Review Platform |
| fromdate | Refers to Reviewed Date (Eg: 2016-10-20 23:55:45) |
| todate | Refers to Reviewed Date (Eg: 2016-10-30 23:55:45) |
Response codes received in the response parameter statuscode are explained below.
\n| 1 | Success |
| 5 | Search returned 0 results |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"fromdate\":null,\n\t\"todate\":null,\n\t\"page\":3\n}"},"url":"https://api.growthscore.io/v1/testimonials","description":"List testimonials received from happy users. Filter the results using below parameters
\n| Parameter | Description |
| page | Page number. API limits to 50 records at once |
| fromdate | Refers to Testimonial Date (Eg: 2016-10-20 23:55:45) |
| todate | Refers to Testimonial Date (Eg: 2016-10-30 23:55:45) |
Response codes received in the response parameter statuscode are explained below.
\n| 1 | Success |
| 5 | Search returned 0 results |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"emailid\":\"xy4@gmail.com\",\n\t\"transactionvalue\":300,\n\t\"customid\":\"7647362876\",\n\t\"extrainfo\":\"subscriptionq:Gold,usertypeq:2,revenue:2000.45,premiumq:true\"\n}"},"url":"https://api.growthscore.io/v1/registerconversionevent","description":"This API to notify GrowthScore about the user conversion. In general, the API is invoked once the Friend has made his first payment.
\n| Parameter | Description |
| emailid * | Email Id |
| storeid | External Id |
| transactionvalue | Transaction amount (number) |
| customid | Unique ID for an Event to avoid duplicate rewards upon retry |
| extrainfo | Custom Info which is stored across the event and will be provided back in web hook. \nIt is generally used to save transaction information which can be used to cross check later while rewarding. If the content has any special characters use Encoded URI format |
Response codes received in the response parameter statuscode are explained below.
\n| 1 | Event registered sucessfully |
| 2 | Referrals isn't enabled |
| 3 | Not a valid user |
| 4 | User is not a friend |
| 5 | Event is registered earlier |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"rewards\":[{\n\t\t\"rewardid\":2343,\n\t\t\"rewardstatus\": \"Approved\"\n\t},\n\t{\n\t\t\"rewardid\":2344,\n\t\t\"rewardstatus\": \"Rewarded\",\n\t\t\"reward\":100\n\t},\n\t{\n\t\t\"rewardid\":2345,\n\t\t\"rewardstatus\": \"Rejected\",\n\t\t\"comment\":\"User cancelled Susbscription\"\n\t}]\n}"},"url":"https://api.growthscore.io/v1/changerewardstatus","description":"This API is to update GrowthScore about status change of the user reward. Using this API reward status can be changed to Approved, Rejected, Suspicious, Rewarded. Once the reward is changed to Rewarded it can't be reverted back.
\n| Parameter | Description |
| rewardid | rewardid received in Webhook |
| rewardstatus | Reward Status |
| reward | rewarded amount (optional) |
| comment | Custom info which is stored across the reward |
Response codes received in the response parameter statuscode are explained below.
\n| 1 | Success |
| 2 | Account is de-activated |
| 3 | Few rewards status is not updated |
API Key from the Dashboard
\n"}],"body":{"mode":"raw","raw":"{\n\t\"rewardid\":2343\n}"},"url":"https://api.growthscore.io/v1/checkrewardstatus","description":"This API call allows you to check upon the status of any reward at any time. This could be useful when you would like to check upon the reward status, before you go ahead and credit it to the user.
\nIt is recommended that you filter out all rewards marked as Suspicious or Rejected, before proceeding to credit the user
\n","urlObject":{"protocol":"https","path":["v1","checkrewardstatus"],"host":["api","growthscore","io"],"query":[],"variable":[]}},"response":[{"id":"07081c80-6e61-750c-1a2e-b94ab5498e10","name":"Check Reward Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Auth-GSKey","value":"04706187338b483390c1a7c200993e52","description":"API Key from the Dashboard"}],"body":{"mode":"raw","raw":"{\n \"rewardid\":184\n}"},"url":"https://api.growthscore.io/v1/checkrewardstatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"96","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 28 Nov 2017 07:10:59 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"292","body":"{\"reward\":{\"rewardid\":184,\"rewardstatus\":\"Pending\",\"reward\":20.0},\"success\":true,\"statuscode\":1}"}],"_postman_id":"118b808c-45fa-9499-7e54-c265d7ca8841"},{"name":"Change Email Subscription","id":"bead30d5-7f0b-423a-9531-4d79dfc57203","request":{"method":"POST","header":[{"key":"Auth-GSKey","value":"cada81d7f4ca4122af49a7d200a9202d"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"emailid\" : \"test1@stag.growthscore.io\",\n\t\"action\":\"Unsubscribe\"\n}"},"url":"https://api.growthscore.io/v1/emailsubscription","description":"Allows you to subscribe or unsubscribe users for sending automated mails.
\nIf you unsubscribe a user using this api then user will not be receiving any mails related NPS, Reviews, Testimonials and Referrals.
\nRequest Model
\n| Parameter | Description |
| emailid | Email of the User. |
| action | \"Unsubscribe\" – To unsubscribe the user.\n\"Subscribe\" – To subscribe back the user |
| 2 | Contact added |
| 3 | Contact updated |
| 4 | Missing emailid. Email is mandatory to save contact |
This API call is to learn about the formats supported by GrowthScore. A discovery request can be submitted via HTTP GET to the following endpoint will provide information about the parameters to identify the users.
\nResponse Model
\n| Parameter | Description |
| api_version | Version string representing the supported version |
| supported_identities | Array of \"identity_type\" and \"identity_format\" pairs. |
| ~ identity_type | Identity type keys supported\n\"email\" – Email Id\n\"storeid\" – External Id |
| ~ identity_format | Identity formats supported. |
| supported_subject_request_types | Array of \"subject_request_type\" supported. |
This API to register a GDPR Request
\nRequest Model
\n| Parameter | Description |
| subject_request_id | UUID v4 string. This must be generated by the controller at the time of request submission to a Processor. |
| subject_request_type | Request type will be \"erasure\" always. |
| submitted_time | RFC 3339 date string representing the time of the original request by the data subject. Note that all timestamps are sent in UTC |
| subject_identities | Array of Identity Objects covering the type, value and format of the user ID |
| ~ identity_type | You can provide \"email\" or \"storeid\" as identity_type |
| ~ identity_value | string value representing the identity. |
| ~ identity_format | Identify format will always be \"raw\". |
Response Model
\n| Parameter | Description |
| controller_id | Account ID in Growthscore. |
| expected_completion_time | RFC 3339 date string representing the time when the Processor expects to fulfill the request. |
| received_time | RFC 3339 date string representing the time when the Processor received the request. |
| encoded_request | Base64 encoding of the entire body of the request. |
| subject_request_id | UUID v4 string from the originating request. |
This API will be useful to check the status of the GDPR requests submitted using subject_request_id. You can get the subject_request_id from the response of “GDPR Register” API call. Supported status types are listed below.
\npending – Request has been received and is currently in the queue
\nin_progress – Request is currently being acted on
\ncompleted – Request is fulfilled
\ncancelled – Request is cancelled
\nResponse Model
\n| Parameter | Description |
| controller_id | Account ID in Growthscore. |
| expected_completion_time | RFC 3339 date string representing the time when the Processor expects to fulfill the request. |
| request_status | Status of the request raised. |
| subject_request_id | UUID v4 string from the originating request. |
This API will be useful to cancel a GDPR request, based on its subject_request_id, but only during the pending phase. You can get the subject_request_id from the response of “GDPR Register” API call.
\nResponse Model
\n| Parameter | Description |
| controller_id | Account ID in Growthscore. |
| received_time | RFC 3339 date string representing the time when the Processor received the cancellation request. |
| subject_request_id | UUID v4 string from the originating request. |