Kartra Documentation Technical Documentation for Kartra

If lead completes a survey

Below is the data passed by our Outbound API system when a lead completes a survey.

Parameters Values
lead
{
    "id": integer,
    "first_name": string,
    "middle_name": string,
    "last_name": string,
    "last_name2": string,
    "email": string,
    "phone_country_code": string,
    "phone": string,
    "company": string,
    "address": string,
    "city": string,
    "zip": string,
    "state": string,
    "country": string,
    "date_joined": string (YYYY-mm-dd hh:mm:ss),
    "website": string,
    "ip": string,
    "ip_country": string,
    "facebook": string,
    "twitter": string,
    "linkedin": string,
    "google_plus": string,
    "sales_tax_id": string,
    "lead_picture": string,
    "source": string,
    "score": integer,
    "referring_id": integer, 
    "blacklisted": integer,    
    "source_id": integer,
    "gdpr_lead_status": integer,
    "gdpr_lead_status_date": string,
    "gdpr_lead_status_ip": string,
    "gdpr_lead_communications": integer,
    "lead_preferred_time_zone": string,
    "custom_fields": [
	{
	    "field_id":integer,
	    "field_identifier":string,
	    "field_type":string,
	    // In the case of input_field and text_area this will be string, else it will have ht following structure:
	    "field_value":[
		{
	            "option_id":integer,
		    "option_value":string,
		},
		{
		    "option_id":integer,
		    "option_value":string,
		}
	    ]
	}
    ]
}
  • id: A unique numeric identifier for the lead.
  • first_name: The lead’s first name.
  • last_name: The lead’s last name.
  • email: The lead’s email address.
  • gdpr_lead_status: The lead’s GDPR status, possible values:
    0 – For GDPR status off – Your account has GDPR deactivated
    1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
    2 – For GDPR status accepted – The lead has accepted the GDPR terms
    3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
    4 – For GDPR status unknown – The lead’s location could not be determined
    5 – For GDPR status pending
  • gdpr_lead_status_date: The date of the last GDPR status change
  • gdpr_lead_status_ip: The IP of the last GDPR status change
  • gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
  • custom fields:
    • field_id – the unique id reference (integer)
    • field_identifier – the unique identifier chosen when it was created (string)
    • field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
    • field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array . In the case of checkboxes the values can have multiple values:
      [
      	{
      		"option_id":1, // the unique id reference (integer)
      		"option_value":"red", // option value (string)
      	},
      	{
      		"option_id":integer,
      		"option_value":string,
      	}
      ]
action
  • survey_complete
action_details
"survey":{
    "survey_id":integer,
    "survey_name":string,
    "survey_type":integer,
    "survey_score":string,
    "survey_completion_time":integer,
    "questions":[
        {
            "question_id":integer,
            "question_title":string,
            "question_correct":integer,
            "answers":[
                {
                    "option_id": integer,
                    "option_value": string
                },
                {
                    "option_id": integer,
                    "option_value": string
                }
            ]
        },
        { 
            "question_id":integer, 
            "question_title":string,
            "question_correct":integer,
            "answers":[
                {
                    "option_id": integer,
                    "option_value": string
                },
                {
                    "option_id": integer,
                    "option_value": string
                }
            ]
        }
    ],
}
    • survey_id: A unique numeric identifier for the kartra survey.
    • survey_name: The kartra survey name.
    • survey_type: The kartra survey type, possible values:
      • 1 – Survey
      • 2 – Quiz
    • survey_score: The kartra survey score, possible values:
      • N/A – in case of non-quiz survey types.
      • the score as a number
    • survey_completion_time: The kartra survey completion time in seconds
    • questions: An array with all the kartra survey questions.
      • question_id: A unique numeric identifier for the kartra survey question.
      • question_title: The kartra survey question title.
      • question_correct: If the kartra survey question is correct or not, posible values:
        • 0 – Excluded
        • 1 – Correct
        • 2 – Incorrect
      • answers: An array with all the lead answers:
        • option_id: the unique id reference (integer) or 0 in case of text answers
        • option_value: the answer value

© 2022 Kartra All Rights Reserved