Skip to navigation

Get Email Campaign List

View as Markdown

Lists the email campaigns the calling organisation (or tribe) has sent, newest first, with the same results the campaign’s analytics panel shows.

Only campaigns that have finished sending are listed. Drafts, scheduled campaigns and campaigns a tribe rejected never appear, and a Tribe Campaign’s results include only the tribes that sent their copy.

Parameters

ParameterNotes
pagePage number, from 1.
results_per_pageUp to 25. Defaults to 25. Over 25 returns 422.
sent_afterCampaigns sent at or after this moment.
sent_beforeCampaigns sent strictly before this moment. Must be later than sent_after, or the request returns 422.
tribe_idWhat one tribe sent. Organisation keys only; a tribe key naming a different tribe gets 403.

Both dates take a full ISO-8601 timestamp with its offset, such as 2026-09-01T00:00:00+10:00. URL-encode the + as %2B: a + left as it is arrives as a space and the request is refused with 422. To report on one month, set sent_after to the first moment of the month and sent_before to the first moment of the next one; a campaign sent exactly at midnight then belongs to one month only.

There is no updated_after: a campaign’s counts change every time someone opens or clicks it. To keep a report current, read its sent_after / sent_before window again.

Organisation and tribe campaigns — type tells you how a campaign reached people:

typeWhat it is
OrganisationSent by the organisation to its own mailing list.
Tribe CampaignWritten by the organisation and pushed to several tribes, each of which sends its own copy. Its counts are the total across every tribe.
TribeSent by one tribe: the tribe’s own campaign, or its copy of a Tribe Campaign (then parent_campaign_id names the Tribe Campaign).
  • An organisation key without tribe_id lists the Organisation campaigns, the Tribe Campaigns (each once, with the total) and every tribe’s own campaigns.
  • An organisation key with tribe_id lists everything that tribe sent, including its copies of Tribe Campaigns, each with that tribe’s own results.
  • A tribe key always lists its own tribe.

Fields — id, name, subject, type, status (always Finished), sent_at (UTC), parent_campaign_id, tribe_id / tribe, audience (tribes, mailing_lists, person_categories, tribe_types, each a list of id and name), preview_image_url (a picture of the email, or null), counts, created_at, updated_at.

Counts

CountMeaning
recipientsPeople the campaign was addressed to.
deliveredEmails the receiving mail server accepted.
openedPeople who opened it, each counted once.
clickedPeople who clicked a link, each counted once. Clicks on the unsubscribe link are not counted.
unsubscribedUnsubscribes from this campaign.
failedEmails that could not be delivered.
bouncedEmails returned by the receiving mail server.

The analytics panel shows delivered, failed and bounced as a percentage of recipients, opened as a percentage of delivered, and clicked and unsubscribed as a percentage of both opened and delivered. Counts are read live, so re-read a month when you build its report.

API key permissions — a key limited to chosen endpoints needs Marketing › Email Campaigns ticked, or it gets 403. Full Access keys, and keys made before endpoint permissions existed, already have it.

Not cached. Success is HTTP 201, not 200.

Full guide: Email campaign results on the API.

Headers

GorillaDash-Api-KeystringOptional
Gorilla Dash API Key
GorillaDash-Api-SecretstringOptional
Gorilla Dash API Secret

Query parameters

sent_afterstringOptional

Sent at or after this moment. Full ISO-8601 timestamp with offset; encode + as %2B.

sent_beforestringOptional

Sent strictly before this moment. Must be later than sent_after (422 otherwise).

Response

Created
statusinteger
successboolean
datalist of objects
paginationobject

Errors

403
Forbidden Error
422
Unprocessable Entity Error