/impactshopCreate Event Impact Shop
Create event impact shop
Implementation Notes
This API call creates templates that help the user call all mandatory parameters (shopName, horizon, and startDate along with any of the permuted parameters listed below) that are used to filter the event impact dataset. Once defined, it can be called as needed or linked to a Schedule.
Search Criteria - Permuted Parameters:
eventids,shopName,horizon,startDateestimatedAttendee,shopName,horizon,startDatecity,shopName,horizon,startDatecountry,shopName,horizon,startDatecity,country,shopName,horizon,startDatecity,estimatedAttendee,shopName,horizon,startDatecountry,estimatedAttendee,shopName,horizon,startDate
Parameter Details:
-
shopName - Your custom name for the
impactShopId. -
horizon - How many consecutive days from the call date to retrieve data for (days out). The maximum value for the horizon is 365.
-
startDate - Start date for the data retrieval.
Format:"2021-10-02" -
estimatedAttendee - Attendee count range or value. Format:
- Range value -
100-500 - Min value -
<500 - Max value -
>500 - Exact value -
500
- Range value -
-
category - A string containing category codes. It can be a number, a range, or both separated by commas.
Example:{ "category": "2,4-5" } -
subCategory - A string containing subCategory codes. It can be a number, a range, or both separated by commas. Example:
{ "subCategory": "2,7,10-15" }
Mandatory Fields:
- shopName
- horizon
- startDate
Example 1:
{ "shopName": "Music Festival Shop", "estimatedAttendee": ">500", "city": "Virar", "country": "Australia", "startDate": "2026-04-01", "horizon": 90, "eventIds": [1], "category": "2", "subCategory": "10-14" }
Example 2:
{ "shopName": "NYEvents_2022_1000", "estimatedAttendee": ">1000", "city": "Taorem", "country": "Sweden", "startDate": "2026-04-01", "horizon": 90, "eventIds": [1], "category": "4", "subCategory": "2,7" }
/impactshopParameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | object | Required | none |
» shopName | body | string | Optional | Custom name for the event shop. |
» estimatedAttendee | body | string | Optional | Attendee count filter in range or exact values. |
» city | body | string | Optional | City where the event takes place. |
» country | body | string | Optional | Country where the event takes place. |
» startDate | body | string(date) | Optional | The starting date for event impact retrieval. |
» horizon | body | integer | Optional | Number of days for impact retrieval (max- 365). |
» eventIds | body | [integer] | Optional | List of event IDs to filter impact data. |
» category | body | string | Optional | Category codes separated by commas or ranges. |
» subCategory | body | string | Optional | Subcategory codes separated by commas or ranges. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 429 | Too Many Requests | Too Many Requests | None |
| 500 | Internal Server Error | Internal Server Error | None |
Example Request
# You can also use wget
curl -X POST https://api.events.example.com/api/v1/impactshop \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses
{
"shopName": "Music Festival Shop",
"estimatedAttendee": ">500",
"city": "Virar",
"country": "Australia",
"startDate": "2026-04-01",
"horizon": 90,
"eventIds": [1],
"category": "2",
"subCategory": "10-14"
}Body parameter
{
"shopName": "",
"estimatedAttendee": "",
"city": "",
"country": "",
"startDate": "2019-08-24",
"horizon": 0,
"eventIds": [],
"category": "0",
"subCategory": "0"
}
Example responses
{
"message": "Event impact shop created successfully",
"impactShopId": 36418
}
Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.