Skip to main content
REST API: Collections
Nicholas Harms avatar
Written by Nicholas Harms
Updated over 5 months ago

Resource: Public

Create

Valid user session required: No

Public Create Permissions are activated by default

Request Syntax

POST /collect/:collect_token

Request curl

curl \
-H 'Accept-Version: ~1' \
-H 'Content-Type: application/json' \ -X POST \
-d '{"email":"sample@juneapp.com", "_tags":"automated_import"}' \
https://engagement.juneapp.com/collect/:collect_token

Response Codes

200 OK 
500 Server Error

Response Model

{
"_id": <string>,
"data": { Object List Data },
"created_at": <number>,
"version": <number>,
"metrics": {
"activity": { Statistics Data },
"tags": [<string>],
"score": <number>,
"geo_continent":<string>,
"geo_country": <string>,
"geo_city": <string>,
}
}

Get

Valid user session required: No

Public Read Permissions must be activated

Request Syntax

GET /collect/public/:collect_token/:selector/:value

Request curl

curl \
-H 'Accept-Version: ~1' \
-H 'Content-Type: application/json' \ -X GET \
https://engagement.juneapp.com/collect/public/:collect_token/:selector/:value

Response Codes

200 OK 
500 Server Error

Response Model

{
"_id": <string>,
"data": { Object List Data },
"created_at": <number>,
"version": <number>,
"metrics": {
"activity": { Statistics Data },
"tags": [<string>],
"score": <number>,
"geo_continent":<string>,
"geo_country": <string>,
"geo_city": <string>,
}
}

Resource: Private

Create

Valid user session required: Yes

Request Syntax

POST /collect/private/:collect_token

Request curl

curl \
-H "Authorization: Bearer ### API Token ### \
-H 'Accept-Version: ~1' \
-H 'Content-Type: application/json' \ -X POST \
-d '{"email":"sample@juneapp.com, "_tags":"automated_import"}' \
https://engagement.juneapp.com/collect/private/:collect_token

Response Code

200 OK 
406 Unprocessable Entity
410 Gone
500 Server Error

Response Model

{
"_id": <string>,
"data": { Object List Data },
"created_at": <number>,
"version": <number>,
"metrics": {
"activity": { Statistics Data },
"tags": [<string>],
"score": <number>,
"geo_continent":<string>,
"geo_country": <string>,
"geo_city": <string>,
}
}

Get

Valid user session required: Yes

Request Syntax

GET /collect/:collect_token/:collect_id

Request curl

curl \
-H "Authorization: Bearer ### API Token ### \
-H 'Accept-Version: ~1' \
-H 'Content-Type: application/json' \ -X GET \
https://engagement.juneapp.com/collect/:collect_token/:collect_id

Response Codes

200 OK 
500 Server Error

Response Model

{
"_id": <string>,
"data": { Object List Data },
"created_at": <number>,
"version": <number>,
"metrics": {
"activity": { Statistics Data },
"tags": [<string>],
"score": <number>,
"geo_continent":<string>,
"geo_country": <string>,
"geo_city": <string>,
}
}

Update

Valid user session required: Yes

Request Syntax

PUT /collect/:collect_token/:collect_id

Request curl

curl \
-H "Authorization: Bearer ### API Token ### \
-H 'Accept-Version: ~1' \
-H 'Content-Type: application/json' \ -X PUT \
-d '{"email":"sample@juneapp.com"}' \
https://engagement.juneapp.com/collect/public/:collect_token/:collect_id

Response Codes

200 OK 
500 Server Error

Response Model

{
"_id": <string>,
"data": { Object List Data }
"created_at": <number>,
"version": <number>,
"metrics": {
"activity": { Statistics Data }
"score": <number>,
"geo_continent":<string>,
"geo_country": <string>,
"geo_city": <string>,
}
}

Delete

Valid user session required: Yes

Request Syntax

DELETE /collect/:collect_token/:collect_id

Request Model

curl \
-H "Authorization: Bearer ### API Token ### \
-H 'Accept-Version: ~1' \
-H 'Content-Type: application/json' \ -X DEL \
https://engagement.juneapp.com/collect/:collect_token/:collect_id

Response Codes

200 OK 
500 Server Error

Response Model

- none -

πŸ§‘β€πŸ’» Contact & Support

Do you need help setting up an integration? Our developers will be happy to help you. Book a suitable appointment here.

Did this answer your question?