Provides the ability to list and create Dynamic Questions
{
"field": "string",
"set": "int",
"question": "string",
"id": "int",
"options": "string"
}
Provides the ability to get put and destroy Dynamic Questions
{
"field": "string",
"set": "int",
"question": "string",
"id": "int",
"options": "string"
}
{}
Provides the ability to list and create FocusGroups
{
"updated_by": "int",
"campaign": "int",
"title": "string",
"date_updated": "datetime",
"date_created": "datetime",
"company": "int",
"type": "int",
"id": "int",
"created_by": "int"
}
Provides the ability to get and put a FocusGroup
{
"updated_by": "int",
"campaign": "int",
"title": "string",
"date_updated": "datetime",
"date_created": "datetime",
"company": "int",
"type": "int",
"id": "int",
"created_by": "int"
}
Provides the ability to list and create FocusGroups
{
"profile_field": "string",
"updated_by": "int",
"date_updated": "datetime",
"date_created": "datetime",
"order": "int",
"question": "string",
"id": "int",
"created_by": "int",
"focus_group": "int"
}
Provides the ability to get and put a FocusGroup
{
"profile_field": "string",
"updated_by": "int",
"date_updated": "datetime",
"date_created": "datetime",
"order": "int",
"question": "string",
"id": "int",
"created_by": "int",
"focus_group": "int"
}
Provides the ability to list and create Focus Group Questionnaire Answers
{
"answer": "string",
"updated_by": "int",
"date_updated": "datetime",
"date_created": "datetime",
"question": "int",
"id": "int",
"created_by": "int",
"order": "int"
}
Provides the ability to get and put a FocusGroup
{
"updated_by": "int",
"campaign": "int",
"title": "string",
"date_updated": "datetime",
"date_created": "datetime",
"company": "int",
"type": "int",
"id": "int",
"created_by": "int"
}
Provides the ability to list and create Focus Group
{
"mobile_no": "string",
"id": "int",
"complete": "int",
"focus_group": "int"
}
Provides the ability to list and create FocusGroups
{}
Returns the total number of contacts a focus group has
{}
Returns the total number of contacts a focus group has
{}
Allow a company to inject profile data into construct.
Expects data as a list of profiles in json, with at least a single identity field eg:
[{"name": "ken von ruben", "gender": "m", "country": "south africa", "mobile_number": "27826468020"}]
{}
List all profile fields which is available within construct.
Only fields within the returned list will be accepted when trying to import external user profiles into construct.
If more fields are required they can be requested.
{}
dictionary of all profile fields and their "user friendly" names
{}
You can test this API using the link below.
{
"category": "int",
"tags": "list",
"keywords": "string",
"title": "string",
"id": "int",
"additional_data": "unknown"
}
Provides the ability to list active miner templates
{
"id": "int",
"title": "string"
}
Provides the ability to retrieve details on a miner template
{
"id": "int",
"title": "string"
}
Provides the ability to view active miners for all campaigns within a company
{
"id": "int",
"campaign": "unknown",
"template": "int"
}
Provides the ability to retrieve update or delete from active campaign miners
{
"id": "int",
"campaign": "unknown",
"template": "int"
}
{}
{}
Query and retrieve results
{}
Query and retrieve results
{}
Query and retrieve results
{}
Listing of saved queries.
{
"query_params": "string",
"order_by": "string",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"query_type": "string",
"company": "int",
"created_by": "int",
"query_action": "string",
"owner": "int",
"date_created": "datetime",
"id": "int"
}
Provides the ability to retrieve update or destroy a saved query
{
"query_params": "string",
"order_by": "string",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"query_type": "string",
"company": "int",
"created_by": "int",
"query_action": "string",
"owner": "int",
"date_created": "datetime",
"id": "int"
}
Provides the ability to retrieve all available queries
{
"query_params": "string",
"order_by": "string",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"query_type": "string",
"company": "int",
"created_by": "int",
"query_action": "string",
"owner": "int",
"date_created": "datetime",
"id": "int"
}
Provides the ability to export profile data
{}
Provides listing ability for interactions
{}
Provides the ability to retrieve individual interactions
{}
Provides ability to list interactions for a group
{}
Provides the ability to retrieve individual interactions on a group
{}
Provides listing and creation ability for transactions.
Data will be going in with a POST, each transaction requires at least one identity field which can be found at /construct/injectors/profiles/availablefields/ as well as a date_received field.
Any fields required can be posted in such as invoice_no or part_no or whatever else is required, although only fields matching profile fields (which is found at the available fields url above) will be pulled into the actual profile.
as an example a transaction is sent through as a dictionary or a list of dictionaries for bulk operations.
{"date_received": "2014-01-01 15:00:00", "mobile_number": "27735522932", "invoice_no": 8822, "some_variable_field": "variable_data", "gender": "m", "campaign_id": 77}
{}
Provides the ability to list and create construct profiles
{}
Provides the ability to view stats on the health of data within a company.
{}
Provides the ability to retrieve individual company profiles.
{}
Provides the ability to list and create construct profiles
{}
Provides the ability to view stats on the health of data within a group.
{}
Provides the ability to retrieve individual company profiles.
{}