Get a campaign report

This field has no description in the spec.

• campaignId#stringin pathrequired

10 of 12 fields have no description in the spec.

• reportId#stringalways returned

• type#ReportTypealways returned

  CAMPAIGNACCOUNT

• status#ReportStatusalways returned

  PENDINGSENT

• startDate#string (date-time)

• endDate#string (date-time)

• accountId#stringalways returned

• campaignId#string

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

• assets#AssetWithUrl[]always returned

  11 child fields

  • assetIdstringalways returned

  • typeAssetTypealways returned

    REPORT_INTROREPORT_TOP_SDGSREPORT_TOP_CHARITIESREPORT_GLOBALREPORT_CHARITY_FIRSTREPORT_CHARITY_SECONDREPORT_CHARITY_THIRDREPORT_CHARITY_FOURTHREPORT_CHARITY_FIFTHREPORT_OUTROREPORT_VIDEOREPORT_PDF

  • colorSchemeAssetColorSchemealways returned

    DEFAULTCUSTOMER

  • formatAssetFormatalways returned

    STORYFEED

  • hideAmountbooleanalways returned

  • fileRefstringalways returned

  • accountIdstringalways returned

  • reportIdstringalways returned

  • createdAtstring (date-time)always returned

  • updatedAtstring (date-time)always returned

  • urlstringalways returned

    Public url of the generated file.

• donationsCSV#string

  Campaign reports only. CSV of the claimed donations, or of the cast votes for a DISTRIBUTION campaign.

• commentsCSV#string

  Campaign reports only. CSV of the feedbacks left by the participants, null without any feedback.

Errors

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }

• 403Forbidden

  Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.

  {
    "statusCode": 403,
    "message": "Forbidden"
  }

• 404Not Found

  No resource with this id on your account: the API answers as if it did not exist.

  {
    "statusCode": 404,
    "message": "Not Found"
  }