Get Top Causes

get

https://reporting.api.shoppinggives.com/top-causes

Authorization: Store:Dashboard

Query Params

time-zone

int32

required

Offset from UTC of the time zone you'd like to search for, calculated by UTC - local time (ie: CST would be -6).

start-date

date-time

required

Top causes created after this date will be returned by the search.

end-date

date-time

required

Top causes created before this date will be returned by the search.

sources

string | null

List of sources to return top causes for; must be a CSV of valid integer values.

location-id

string | null

Top causes associated with this location will be returned by the search.

campaigns

string | null

List of campaigns IDs to return top causes for; must be in CSV format.
1 = Online Purchase
2 = Yotpo Redemption
3 = Round Ups
4 = Add-on Donations
5 = Point of Sale

size

int32

Defaults to 5

Number of results to return from this search.

Headers

x-store-id

string | null

Your store ID (we will provide this).

Response

200

Success