.svg){kind=logo}
CRM Data
Description
Get all users data based on filters
Request
URL:
HTML
https://api.picogp.com/v1/messenger/users?order_by=date_added&order_dir=asc&page=1&filters=[[{"type":"last_participation_date","name":"All last_participation_date","include":true,"values":["2021-11-01 10:20:20"]}]]&limit=2500&include_activation=trueHTTP Method: GET
Query Parameters:
order_by - data will order by the select parameter:
[date_added, date_updated]
Default: date_addedorder_dir - data will be ordered asc / desc
Default: ascpage - results page 1 to n - each page has the number of records as specified in the limit parameter.
filters - array of filters - for the current use case use the following parameter - you will only need to replace the following macro with the date to be searched from REPLACE_WITH_DATE_TO_SEARCH_FROM:
[[{"type":"last_participation_date","name":"last_participation_date","include":true,"values":["REPLACE_WITH_DATE_TO_SEARCH_FROM"]}]]limit - the number of records to return in each request min 1 max 2500
Specified users request
There’s also an option to search the CRM for specific users.
This call should be called separately for each platform, by providing the following filter:
Filter parameters:
type: "participants"
platform: fb | tw | pm | in
values: array of user_md_5 values that can be found on each user object
Pico Messenger users request example
JSON
[
[
{
"type": "participants",
"platform": "pm",
"values": [
"a53c6a8766272192303364d02fe6bf931476174f79fa33828ee3d95d5bd0bf89"
],
"include": true
}
]
]Twitter users request example
JSON
[
[
{
"type": "participants",
"platform": "tw",
"values": [
"d7acf2aaa63fd3fe6a1bbdcf698a0b1c"
],
"include": true
}
]
]Facebook users request example
JSON
[
[
{
"type": "participants",
"platform": "pm",
"values": [
"a53c6a8766272192303364d02fe6bf931476174f79fa33828ee3d95d5bd0bf89"
],
"include": true
}
]
]Response
JSON
{
"data": {
"total": 35,
"count": 35,
"users": [
{
"_id": "66deaf000a58c1a1e2e0e462",
"company_id": 4150,
"platform_id": 3,
"user_id": 3082,
"activation_participation_counter": 1,
"activations": [
{
"activation_id": 3724,
"activation_name": "Tap it",
"campaign_id": 298,
"campaign_name": "Liron Competition 2024-04-25",
"activation_date": "2024-09-09 08:05:47"
}
],
"campaigns": [
{
"campaign_id": 298,
"campaign_name": "Liron Competition 2024-04-25"
}
],
"campaigns_participation_counter": 1,
"date_added": 1725869145000,
"date_updated": 1725869154000,
"entity_labels": [
{
"page": null,
"name": "Social ID",
"description": "Social ID",
"dateAdded": "2023-06-27 05:52:06",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "b27aa96147b2a193e40afcaee050c99123e87a31d8a3b1afbc53ade5a0cc8e52",
"source": "MESSAGE",
"userLabelId": "33764",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 6,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "738"
},
{
"page": null,
"name": "Timezone",
"description": "Timezone",
"dateAdded": "2023-06-27 05:52:06",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "-3",
"source": "MESSAGE",
"userLabelId": "33765",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 8,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "768"
},
{
"page": null,
"name": "Date Added",
"description": "Date Added",
"dateAdded": "2023-06-27 05:52:06",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "2023-06-27 05:52:06",
"source": "MESSAGE",
"userLabelId": "33766",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 12,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "811"
},
{
"page": null,
"name": "Locale",
"description": "Locale",
"dateAdded": "2023-06-27 05:52:06",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "en-US",
"source": "MESSAGE",
"userLabelId": "33767",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 7,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "753"
},
{
"page": null,
"name": "Gender",
"description": "Gender",
"dateAdded": "2023-06-27 05:52:06",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "other",
"source": "MESSAGE",
"userLabelId": "33768",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 4,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "708"
},
{
"page": null,
"name": "email",
"description": "email",
"dateAdded": "2023-06-27 05:55:22",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "ohad.aloni@infrontsports.com",
"source": "INPUT",
"userLabelId": "33770",
"referenceId": "1687329560191",
"color": "#FF6209",
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 11,
"inputValueType": null,
"isReadOnly": false,
"isStarred": true,
"activations": [],
"campaigns": [],
"id": "217"
},
{
"page": null,
"name": "Username",
"description": "Username",
"dateAdded": "2023-06-27 05:55:25",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "asd22",
"source": "INPUT",
"userLabelId": "33771",
"referenceId": "1687329560191",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Participants group",
"user": null,
"additionalLabels": [],
"personalInfoType": 51,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "7149"
}
],
"external_id": null,
"is_gdpr_approved": false,
"is_unsubscribed": false,
"labels": [
{
"id": 738,
"name": "Social ID",
"value": "199ec210bcb3a889b53c7d846c5df23118459870ac848814d9d2f2368b5bb91a",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 811,
"name": "Date Added",
"value": "2024-09-09 08:05:45",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 753,
"name": "Locale",
"value": "en-US",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 768,
"name": "Timezone",
"value": "-3",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
}
],
"last_activation_participate_in": {
"activation_id": 3724,
"activation_name": "Tap it"
},
"last_campaign_participate_in": {
"campaign_id": 298,
"campaign_name": "Liron Competition 2024-04-25"
},
"last_channel": 3,
"last_medium": "SHARE_BUTTON",
"latest_engagement": null,
"platform": "pm",
"screen_name": "",
"social_id": "199ec210bcb3a889b53c7d846c5df23118459870ac848814d9d2f2368b5bb91a",
"user_entity_id": 560
},
{
"_id": "66dd7934be2c542f165f65c6",
"company_id": 4150,
"platform_id": 3,
"user_id": 3081,
"activation_participation_counter": 5,
"activations": [
{
"activation_id": 3610,
"activation_name": "Tap IT",
"campaign_id": 320,
"campaign_name": "Liron1/2",
"activation_date": "2024-09-10 06:37:35"
},
{
"activation_id": 3728,
"activation_name": "enter to win",
"campaign_id": 320,
"campaign_name": "Liron1/2",
"activation_date": "2024-09-09 17:17:48"
},
{
"activation_id": 3651,
"activation_name": "sad",
"campaign_id": 331,
"campaign_name": "TEST -ASD",
"activation_date": "2024-09-09 16:35:09"
},
{
"activation_id": 3565,
"activation_name": "Balloons",
"campaign_id": 310,
"campaign_name": "Liron 2024-05",
"activation_date": "2024-09-09 16:18:26"
},
{
"activation_id": 3724,
"activation_name": "Tap it",
"campaign_id": 298,
"campaign_name": "Liron Competition 2024-04-25",
"activation_date": "2024-09-05 10:31:44"
}
],
"campaigns": [
{
"campaign_id": 320,
"campaign_name": "Liron1/2"
},
{
"campaign_id": 331,
"campaign_name": "TEST -ASD"
},
{
"campaign_id": 310,
"campaign_name": "Liron 2024-05"
},
{
"campaign_id": 298,
"campaign_name": "Liron Competition 2024-04-25"
}
],
"campaigns_participation_counter": 4,
"date_added": 1725532303000,
"date_updated": 1725532310000,
"entity_labels": [
{
"page": null,
"name": "Gender",
"description": "Gender",
"dateAdded": "2023-09-28 09:36:51",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "other",
"source": "MESSAGE",
"userLabelId": "34596",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 4,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "708"
},
{
"page": null,
"name": "Locale",
"description": "Locale",
"dateAdded": "2023-09-28 09:36:51",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "en-US",
"source": "MESSAGE",
"userLabelId": "34597",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 7,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "753"
},
{
"page": null,
"name": "Social ID",
"description": "Social ID",
"dateAdded": "2023-09-28 09:36:51",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "0c815c460997b214d15b7f07781f4dc2abaabcb22d38389863abb7138afb0bad",
"source": "MESSAGE",
"userLabelId": "34598",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 6,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "738"
},
{
"page": null,
"name": "Date Added",
"description": "Date Added",
"dateAdded": "2023-09-28 09:36:51",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "2023-09-28 09:36:51",
"source": "MESSAGE",
"userLabelId": "34599",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 12,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "811"
},
{
"page": null,
"name": "Timezone",
"description": "Timezone",
"dateAdded": "2023-09-28 09:36:51",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "-3",
"source": "MESSAGE",
"userLabelId": "34600",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 8,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "768"
},
{
"page": null,
"name": "email",
"description": "email",
"dateAdded": "2023-09-28 09:37:01",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "sapir.cohen@infrontsports.com",
"source": "INPUT",
"userLabelId": "34601",
"referenceId": "1695805621305",
"color": "#FF6209",
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 11,
"inputValueType": null,
"isReadOnly": false,
"isStarred": true,
"activations": [],
"campaigns": [],
"id": "217"
},
{
"page": null,
"name": "Username",
"description": "Username",
"dateAdded": "2023-09-28 09:37:08",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "sapir",
"source": "INPUT",
"userLabelId": "34602",
"referenceId": "1695805621305",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Participants group",
"user": null,
"additionalLabels": [],
"personalInfoType": 51,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "7149"
},
{
"page": null,
"name": "Where do you usually buy our products?",
"description": "Purchasing Frequency",
"dateAdded": "2023-10-04 09:23:38",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "Online",
"source": "MESSAGE",
"userLabelId": "34608",
"referenceId": "1695808211456",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Preferences Brands",
"user": null,
"additionalLabels": [],
"personalInfoType": 44,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "2135"
},
{
"page": null,
"name": "External ID",
"description": "pico messenger external id",
"dateAdded": "2024-08-06 12:04:02",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "150",
"source": "MESSAGE",
"userLabelId": "37270",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 50,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "4448"
},
{
"page": null,
"name": "Push 1",
"description": null,
"dateAdded": "2024-08-06 13:00:17",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "liron1",
"source": "MESSAGE",
"userLabelId": "37294",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Other",
"user": null,
"additionalLabels": [],
"personalInfoType": null,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "76"
},
{
"page": null,
"name": "das",
"description": null,
"dateAdded": "2024-08-06 13:00:17",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "liron2",
"source": "MESSAGE",
"userLabelId": "37295",
"referenceId": null,
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Other",
"user": null,
"additionalLabels": [],
"personalInfoType": null,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "155"
},
{
"page": null,
"name": "First Name",
"description": "first name",
"dateAdded": "2024-09-04 11:38:47",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "sapir",
"source": "MESSAGE",
"userLabelId": "37492",
"referenceId": "1717311810264",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 2,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "677"
},
{
"page": null,
"name": "Country",
"description": "country",
"dateAdded": "2024-09-04 11:38:47",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "Afghanistan",
"source": "MESSAGE",
"userLabelId": "37494",
"referenceId": "1717311810264",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 26,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "2117"
},
{
"page": null,
"name": "Address",
"description": "address",
"dateAdded": "2024-09-09 17:50:31",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "sapir",
"source": "INPUT",
"userLabelId": "37577",
"referenceId": "1725902269028",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 25,
"inputValueType": null,
"isReadOnly": false,
"isStarred": true,
"activations": [],
"campaigns": [],
"id": "2116"
},
{
"page": null,
"name": "Age",
"description": "age",
"dateAdded": "2024-09-09 17:50:31",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "1",
"source": "INPUT",
"userLabelId": "37578",
"referenceId": "1725902269028",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Personal Information",
"user": null,
"additionalLabels": [],
"personalInfoType": 5,
"inputValueType": null,
"isReadOnly": false,
"isStarred": true,
"activations": [],
"campaigns": [],
"id": "722"
},
{
"page": null,
"name": "new new",
"description": null,
"dateAdded": "2024-09-09 17:50:32",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "asdasd",
"source": "INPUT",
"userLabelId": "37579",
"referenceId": "1725902269028",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Subscriptions",
"user": null,
"additionalLabels": [],
"personalInfoType": null,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "360"
},
{
"page": null,
"name": "Who is your favorite player?",
"description": "favorite player",
"dateAdded": "2024-09-10 06:45:45",
"dateUpdated": null,
"isActive": null,
"isPublic": null,
"value": "test",
"source": "MESSAGE",
"userLabelId": "37595",
"referenceId": "1719321379748",
"color": null,
"crmSortIndex": null,
"isCrmPresented": false,
"isDashboardMetric": false,
"dashboardSortIndex": -1,
"usersAmount": null,
"type": "Preferences Sports",
"user": null,
"additionalLabels": [],
"personalInfoType": 31,
"inputValueType": null,
"isReadOnly": false,
"isStarred": false,
"activations": [],
"campaigns": [],
"id": "2122"
}
],
"external_id": null,
"is_gdpr_approved": false,
"is_unsubscribed": false,
"labels": [
{
"id": 753,
"name": "Locale",
"value": "en-US",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 811,
"name": "Date Added",
"value": "2024-09-05 10:31:43",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 768,
"name": "Timezone",
"value": "-3",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 738,
"name": "Social ID",
"value": "da569e2d7e954b478ab578818507de521e8a940abc9620e836f81f6ffa2630fc",
"source": "MESSAGE",
"type": "Personal Information",
"reference_id": null
},
{
"id": 2116,
"name": "Address",
"value": "sapir",
"source": "INPUT",
"type": "Personal Information",
"reference_id": "1725902269028"
},
{
"id": 722,
"name": "Age",
"value": "1",
"source": "INPUT",
"type": "Personal Information",
"reference_id": "1725902269028"
},
{
"id": 360,
"name": "new new",
"value": "asdasd",
"source": "INPUT",
"type": "Subscriptions",
"reference_id": "1725902269028"
},
{
"id": 2117,
"name": "Country",
"value": "Afghanistan",
"source": "INPUT",
"type": "Personal Information",
"reference_id": "1725902269028"
},
{
"id": 2122,
"name": "Who is your favorite player?",
"value": "test",
"source": "MESSAGE",
"type": "Preferences Sports",
"reference_id": "1719321379748"
}
],
"last_activation_participate_in": {
"activation_id": 3610,
"activation_name": "Tap IT"
},
"last_campaign_participate_in": {
"campaign_id": 320,
"campaign_name": "Liron1/2"
},
"last_channel": 3,
"last_medium": "fb_story",
"latest_engagement": null,
"platform": "pm",
"screen_name": "",
"social_id": "da569e2d7e954b478ab578818507de521e8a940abc9620e836f81f6ffa2630fc",
"user_entity_id": 638
}
]
}
}