Skip to main content
POST
/
admin
/
progress_report
Post progress report
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/progress_report \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "date_from": "2022-01-01",
  "date_to": "2022-12-31",
  "hysform_id": "1",
  "program_id": 1,
  "pageIndex": 1,
  "pageSize": 10,
  "type": "donor",
  "client_id": "1"
}
'
{
  "fields": [
    {}
  ],
  "organization": {},
  "forms": [
    {}
  ],
  "total": 100,
  "profile_fields": [
    {}
  ],
  "date_from": "2022-01-01",
  "date_to": "2022-12-31"
}

Authorizations

​
X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

Body

application/json
​
date_from
string<date>
required
Example:

"2022-01-01"

​
date_to
string<date>
required
Example:

"2022-12-31"

​
hysform_id
string
required
Example:

"1"

​
program_id
integer
required
Example:

1

​
pageIndex
integer
required
Example:

1

​
pageSize
integer
required
Example:

10

​
type
string
required
Example:

"donor"

​
client_id
string
Example:

"1"

Response

Successful operation

​
fields
object[]
​
organization
object
​
forms
object[]
​
total
integer
Example:

100

​
profile_fields
object[]
​
date_from
string<date>
Example:

"2022-01-01"

​
date_to
string<date>
Example:

"2022-12-31"