Private IPG Sponsorship Count

The Child Sponsorship Count API is a RESTful API.

The service returns a count of sponsorships based on a GPA office and type of program (CDSP or LDP)

Sample Request

This is an example only.[string]&Program=[string]&Interval=[string]&ClientReferenceId=[string]&api_key=[string]


Service Parameters

Name Description Required Data Type Constraints

Code representing International Partners.

ALL: All
AU: Compassion Australia
CA: Compassion Canada
DE: Compassion Germany
IT: Compassion Italy
KR: Compassion Korea
NL: Compassion Netherlands
CH: Compassion Switzerland
CU: Compassion UK
US: Compassion USA
FR: SEL France
NZ: Team Fund New Zealand
SC: Compassion Scandinavia (This includes Sweden and Norway)

Optional String

Only one code

Default is ALL


Sponsorship programs.

Valid sponsorship programs are:
Optional String

Only one program

Default is ALL


Daily interval returns the net count for the last day.
Hourly interval returns the net count for the last hour.

Valid intervals are:
Optional String

Only one interval

Default is Houlry

ClientReferenceId Uniquely represents the transaction in the client's system. Optional String Max 100
api_key Your Mashery supplied key for an application running Compassion International services. Yes String  

Response Parameters

Name Description
GPAOffice Same value that was in the request.
Program Same value that was in the request.
NetSponsorships Total sponsorships from last time data was collected.
NetChange Net of additions and departures.
Interval Same value as input.
Reporttime Date and Time when data was last collected.

Sample Successful Response

Sample Successful Response

Sample Unsuccessful Response

The service operation will provide the following response when there are missing required parameters.
Exception Returned: (ResponseCode = "1", HTTP Status Code ="404")

Sample Error Response

Error Response Codes

For ResponseCode = 1, the table below indicates the HTTP error response and HTTP Error message.

HTTP Error Response HTTP Error Message
HTTP 400 Service Parameter Failure
HTTP 401 Not Authenticated / Authorized for Service Data
HTTP 403 Not Authorized
HTTP 403 Account Inactive
HTTP 403 Over Queries Per Second Limit
HTTP 403 Over Rate Limit
HTTP 403 Unknown Referrer
HTTP 404 Requested Resource Not Found
HTTP 408 Request Timeout
HTTP 414 Request URI Too Long
HTTP 500 Internal Server Error
HTTP 502 Bad Gateway
HTTP 503 API Maintenance / Service Unavailable
HTTP 504 Gateway Timeout


New comments are not being accepted at this time.

Docs Navigation