Get campaign metrics

1 of 6 fields has no description in the spec.

• campaignId#stringin pathrequired

• createdAt_lt#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_lte#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_gt#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_gte#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• includeMatchedDonationsInMetrics#booleanin query

  Include matched donations made by and charged to the beneficiary in the metrics

No field is described in the spec.

• numberOfDonations#numberalways returned

• totalDonation#numberalways returned

• numberOfMatchedDonations#numberalways returned

• totalMatchedDonation#numberalways returned

• numberOfCharitiesWithDonations#numberalways returned

• usedDonationsMetric#Metricalways returned

  2 child fields

  • valuenumberalways returned

  • percentagenumberalways returned

• sortedCharities#SortedCharity[]always returned

  10 child fields

  • charityIdstringalways returned

  • namestringalways returned

  • logoUrlstringalways returned

  • sustainableDevelopmentGoalsstring[]always returned

    NO_POVERTYZERO_HUNGERGOOD_HEALTH_AND_WELL_BEINGQUALITY_EDUCATIONGENDER_EQUALITYCLEAN_WATER_AND_SANITATIONAFFORDABLE_AND_CLEAN_ENERGYDECENT_WORK_AND_ECONOMIC_GROWTHINDUSTRY_INNOVATION_AND_INFRASTRUCTUREREDUCED_INEQUALITIESSUSTAINABLE_CITIES_AND_COMMUNITIESRESPONSIBLE_CONSUMPTION_AND_PRODUCTIONCLIMATE_ACTIONLIFE_BELOW_WATERLIFE_ON_LANDPEACE_JUSTICE_AND_STRONG_INSTITUTIONSPARTNERSHIPS_FOR_THE_GOALS

  • impactIndicatorsOmitTypeClass[]always returned

    10 child fields

    • userInvitationIdstringalways returned

    • firstNamestringalways returned

    • lastNamestringalways returned

    • emailstringalways returned

    • phonestring

    • statusUserInvitationStatusalways returned

      PENDINGCLAIMEDCANCELED

    • roleRolealways returned

      ADMINMEMBERPAYROLL_MANAGER

    • accountIdstringalways returned

    • createdAtstring (date-time)always returned

    • updatedAtstring (date-time)always returned

  • numberOfDonationsnumberalways returned

  • totalnumberalways returned

  • percentagenumberalways returned

  • totalMatchedDonationnumberalways returned

  • latestDonationstring (date-time)always returned

• sortedSdgs#SortedSustainableDevelopmentGoal[]always returned

  5 child fields

  • sustainableDevelopmentGoalstringalways returned

    NO_POVERTYZERO_HUNGERGOOD_HEALTH_AND_WELL_BEINGQUALITY_EDUCATIONGENDER_EQUALITYCLEAN_WATER_AND_SANITATIONAFFORDABLE_AND_CLEAN_ENERGYDECENT_WORK_AND_ECONOMIC_GROWTHINDUSTRY_INNOVATION_AND_INFRASTRUCTUREREDUCED_INEQUALITIESSUSTAINABLE_CITIES_AND_COMMUNITIESRESPONSIBLE_CONSUMPTION_AND_PRODUCTIONCLIMATE_ACTIONLIFE_BELOW_WATERLIFE_ON_LANDPEACE_JUSTICE_AND_STRONG_INSTITUTIONSPARTNERSHIPS_FOR_THE_GOALS

  • numberOfDonationsnumberalways returned

  • totalnumberalways returned

  • percentagenumberalways returned

  • charitiesLightCharity[]always returned

    3 child fields

    • charityIdstringalways returned

    • namestringalways returned

    • logoUrlstringalways returned

• sortedImpactIndicators#SortedImpactIndicator[]always returned

  9 child fields

  • charityImpactIndicatorIdstringalways returned

  • singularLabelstringalways returned

  • pluralLabelstringalways returned

  • countnumberalways returned

  • totalnumberalways returned

  • countMatchedDonationnumberalways returned

  • totalMatchedDonationnumberalways returned

  • namestringalways returned

  • logoUrlstringalways returned

• monthlyDonations#MonthlyDonation[]always returned

  3 child fields

  • namestringalways returned

  • averagenumberalways returned

  • averageMatchedDonationnumberalways returned

• nps#NPSalways returned

  4 child fields

  • promotersnumberalways returned

  • detractorsnumberalways returned

  • neutralsnumberalways returned

  • scorenumberalways returned

• rating#Ratingalways returned

  1 child field

  • averagenumberalways returned

• comments#Commment[]always returned

  5 child fields

  • feedbackIdstringalways returned

  • commentstring

  • charityCommentCharityalways returned

    2 child fields

    • namestringalways returned

    • logoUrlstringalways returned

  • campaignCommentCampaignalways returned

    2 child fields

    • namestringalways returned

    • logoUrlstring

  • donorCommentDonoralways returned

    1 child field

    • emailstring

• socialSharing#SocialSharingalways returned

  5 child fields

  • LINKEDINSocialSharingMetricalways returned

    2 child fields

    • countnumberalways returned

    • percentagenumberalways returned

  • INSTAGRAMSocialSharingMetricalways returned

    2 child fields

    • countnumberalways returned

    • percentagenumberalways returned

  • FACEBOOKSocialSharingMetricalways returned

    2 child fields

    • countnumberalways returned

    • percentagenumberalways returned

  • TWITTERSocialSharingMetricalways returned

    2 child fields

    • countnumberalways returned

    • percentagenumberalways returned

  • WHATSAPPSocialSharingMetricalways returned

    2 child fields

    • countnumberalways returned

    • percentagenumberalways returned

• emailMetrics#EmailMetricsalways returned

  4 child fields

  • sentMetricalways returned

    2 child fields

    • valuenumberalways returned

    • percentagenumberalways returned

  • openedMetricalways returned

    2 child fields

    • valuenumberalways returned

    • percentagenumberalways returned

  • clickedMetricalways returned

    2 child fields

    • valuenumberalways returned

    • percentagenumberalways returned

  • errorMetricalways returned

    2 child fields

    • valuenumberalways returned

    • percentagenumberalways returned

Errors

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 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"
  }