🎟️ Campaign

A campaign refers to a registration event created on our Events platform. Each campaign will have a unique ID, 'campaign_guid' or 'shared_campaign_guid', which can be used to get information on your registrants, payments made to that event and fundraising pages created.

The following table contains the fields that are returned within the response call of the campaign endpoints.

The first table contains the fields within the response while the others breakdown the nested objects within the response.

Key	Label	Type	Description
account_guid	Account GUID	UUID	Account GUID
campaign_guid	Campaign GUID	UUID	Campaign GUID
date_created	Date Created	Date	Date campaign created
date_from	Date From	Date	Date campaign begins
date_to	Date To	Date	Date campaign ends
date_updated	Date Updated	Date	Date campaign updated
enabled	Enabled	Boolean	Is campaign enabled
name	Name	String	Name of campaign
type	Type	String	Type of campaign

The following table contains the fields that are returned within the response call of the campaign/summary endpoint.

/campaigns/summary

Key	Label	Type	Description
activitySummary	Activity Summary	Activity Summary	Activity summary object
donationsSummary	Donations Summary	Donations Summary	Donations summary object
fundraisingSummary	Fundraising Summary	Fundraising Summary	Fundraising summary object

🏃Activity Summary

Key	Label	Type	Description
distance_logged_unit	Distance Logged Unit	String	Unit used to log distance
total_activities_logged	Total Activities Logged	Long	Total number of logged activities
total_activities_logged_lbl	Total Activities Logged Label	String	Total number of logged activities label
total_activities_logged_str	Total Activities Logged String	String	Total number of logged activities string
total_calories_burned	Total Calories Burned	Long	Total calories burned
total_calories_burned_lbl	Total Calories Burned Label	String	Total calories burned label
total_calories_burned_str	Total Calories Burned String	String	Total calories burned label string
total_distance_logged	Total Distance Logged	Long	Total distance logged
total_distance_logged_lbl	Total Distance Logged Label	String	Logged distance from activities label
total_distance_logged_str	Total Distance Logged String	String	Logged distance from activities string
total_height_climbed	Total Height Climbed	Long	Total height climbed
total_height_climbed_lbl	Total Height Climbed Label	String	Total height climbed label
total_height_climbed_str	Total Height Climbed String	String	Total height climbed string
total_time_logged	Total Time Logged	Long	Total time logged
vtotal_time_logged_lbl	Total Time Logged Label	String	Total time logged label
total_time_logged_str	Total Time Logged String	String	Total time logged string

💳 Donations Summary

Key	Label	Type	Description
total_donations	Total Donations	Long	Total donations
total_donations_lbl	Total Donations Label	String	Total donations label
total_donations_str	Total Donations String	String	Total donations string

💫 Fundraising Summary

Key	Label	Type	Description
total_fundraisers	Total Fundraisers	Long	Total fundraisers
total_fundraisers_lbl	Total Fundraisers Label	String	Total fundraisers label
total_fundraisers_str	Total Fundraisers String	String	Total fundraisers string
total_raised	Total Raised	Long	Total amount raised
total_raised_giftaid	Total Raised Giftaid	Long	Total amount raised through Gift Aid
total_raised_giftaid_lbl	Total Raised Giftaid Label	String	Total amount raised through Gift Aid label
total_raised_giftaid_str	Total Raised Gift Aid String	String	Total amount raised through Gift Aid string
total_raised_lbl	Total Raised Label	String	Total amount raised label
total_raised_offline	Total Raised Offline	Long	Total amount raised offline
total_raised_offline_lbl	Total Raised Offline Label	String	Total amount raised offline label
total_raised_offline_str	Total Raised Offline String	String	Total amount raised offline string
total_raised_online	Total Raised Online	Long	Total amount raised online
total_raised_online_lbl	Total Raised Online Label	String	Total amount raised online label
total_raised_online_str	Total Raised Online String	String	Total amount raised online string
total_raised_str	Total Raised String	String	Total amount raised string
total_target	Total Target	Long	Total target
total_target_lbl	Total Target Label	String	Total target label
total_target_str	Total Target String	String	Total target string
total_teams	Total Teams	Long	Total raised by teams
total_teams_lbl	Total Teams Label	String	Total raised by teams label
total_teams_str	Total Teams Str	String	Total raised by teams string

🚀 Return a list of campaigns within your account

/campaigns

Get a list of all of your campaigns filterable by the attributes below:

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the campaign object
date_from	Date From	String	Date from which to filter based on the created date of the campaign object
date_to	Date To	String	Date to filter to based on the created date of the campaign object
limit	Limit	Integer	Number of records to be returned in the response
page	Page	Integer	The number of pages to skip before starting to collect the result set
search	Search	String	String to search by
type	Type	String	Used to filter response, values can be: -Team -Individual.

Sample Request

GET - http://dataapi.enthuse.com/campaigns/search?api_key=eje2381
&campaign_guid=00000000-0000-0000-0000-000000000000
&date_from=2022-11-3100:00:00
&date_to=2022-12-31 00:00:00
&limit=25
&page=1

Sample Responses:

200 - OK call was successful and returned data

{
  "campaignSearchList": [
    {
      "name": "string",
      "pageUrl": "string",
      "profilePic": "string",
      "teamName": "string",
      "teamPageUrl": "string",
      "totalRaised": 0,
      "type": "string"
    }
  ],
  "message": "string",
  "status": 0
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

413 - Call authenticated but no filters used

{
  "message": "Please enter some form of filter",
  "status": 413
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}

🚀 Retrieve an existing campaign

campaigns/{campaign_guid}

Use a known 'campaign_guid' to return information on that campaign.

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the campaign object

Sample Request

GET - http://dataapi.enthuse.com/campaigns/?access_token=qRXe5sM-yOAHzA1jtfyxSTPbgVg
&campaign_guid=00000000-0000-0000-0000-000000000000
&date_from=2022-11-3100:00:00
&date_to=2022-12-3100:00:00
&limit=25
&page=1

Sample Responses:

200 - OK was successful and returned data

{
  "campaignList": [
    {
      "account_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "date_created": "2020-01-01 00:00:00",
      "date_from": "2020-01-01 00:00:00",
      "date_to": "2020-01-01 00:00:00",
      "date_updated": "2020-01-01 00:00:00",
      "enabled": true,
      "name": "string",
      "type": "string"
    }
  ],
  "message": "string",
  "status": 0
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

*500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}

🚀 Return a summary for a single or multiple campaigns

/campaigns/summary

Use multiple known values for 'campaign_guid' to return information on those campaigns.

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the campaign object

Sample Request

GET - http://dataapi.enthuse.com/campaigns/summary?api_key=S52z44ag
&campaign_guid=00000000-0000-0000-0000-000000000000

Sample Responses:

200 - OK call was successful and returned data

{
  "activitySummary": {
    "distance_logged_unit": "string",
    "total_activities_logged": 0,
    "total_activities_logged_lbl": "string",
    "total_activities_logged_str": "string",
    "total_calories_burned": 0,
    "total_calories_burned_lbl": "string",
    "total_calories_burned_str": "string",
    "total_distance_logged": 0,
    "total_distance_logged_lbl": "string",
    "total_distance_logged_str": "string",
    "total_height_climbed": 0,
    "total_height_climbed_lbl": "string",
    "total_height_climbed_str": "string",
    "total_time_logged": 0,
    "total_time_logged_lbl": "string",
    "total_time_logged_str": "string"
  },
  "donationSummary": {
    "total_donations": 0,
    "total_donations_lbl": "string",
    "total_donations_str": "string"
  },
  "fundraisingSummary": {
    "total_fundraisers": 0,
    "total_fundraisers_lbl": "string",
    "total_fundraisers_str": "string",
    "total_raised": 0,
    "total_raised_giftaid": 0,
    "total_raised_giftaid_lbl": "string",
    "total_raised_giftaid_str": "string",
    "total_raised_lbl": "string",
    "total_raised_offline": 0,
    "total_raised_offline_lbl": "string",
    "total_raised_offline_str": "string",
    "total_raised_online": 0,
    "total_raised_online_lbl": "string",
    "total_raised_online_str": "string",
    "total_raised_str": "string",
    "total_target": 0,
    "total_target_lbl": "string",
    "total_target_str": "string",
    "total_teams": 0,
    "total_teams_lbl": "string",
    "total_teams_str": "string"
  }
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

*500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}

🚀 Return a list of registrants and teams within your account

/campaigns/search

Retrieve data on the registrants and teams for your campaigns

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the campaign object
date_from	Date From	String	Date from which to filter based on the created date of the campaign object
date_to	Date To	String	Date to filter to based on the created date of the campaign object
limit	Limit	Integer	Number of records to be returned in the response
page	Page	Integer	The number of pages to skip before starting to collect the result set
search	Search	String	String to search by
type	Type	String	Used to filter response, values can be: -Team -Individual.

Sample Request

GET - http://dataapi.enthuse.com/campaigns/search?api_key=eje2381
&campaign_guid=00000000-0000-0000-0000-000000000000
&date_from=2022-11-3100:00:00
&date_to=2022-12-31 00:00:00
&limit=25
&page=1

Sample Responses:

200 - OK call was successful and returned data

{
  "campaignSearchList": [
    {
      "name": "string",
      "pageUrl": "string",
      "profilePic": "string",
      "teamName": "string",
      "teamPageUrl": "string",
      "totalRaised": 0,
      "type": "string"
    }
  ],
  "message": "string",
  "status": 0
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

413 - Call authenticated by no filters used

{
  "message": "Please enter some form of filter",
  "status": 413
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}