Progress Reports
Post progress report
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"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/progress_report"
payload = {
"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"
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/progress_report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helpyousponsor.com/v1/admin/progress_report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.helpyousponsor.com/v1/admin/progress_report"
payload := strings.NewReader("{\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"hysform_id\": \"1\",\n \"program_id\": 1,\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"type\": \"donor\",\n \"client_id\": \"1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-HYS-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.helpyousponsor.com/v1/admin/progress_report")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"hysform_id\": \"1\",\n \"program_id\": 1,\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"type\": \"donor\",\n \"client_id\": \"1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/progress_report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"hysform_id\": \"1\",\n \"program_id\": 1,\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"type\": \"donor\",\n \"client_id\": \"1\"\n}"
response = http.request(request)
puts response.read_body{
"fields": [
{}
],
"organization": {},
"forms": [
{}
],
"total": 100,
"profile_fields": [
{}
],
"date_from": "2022-01-01",
"date_to": "2022-12-31"
}{
"errors": {
"date_from": "The date from field is required."
}
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
⌘I
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"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/progress_report"
payload = {
"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"
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/progress_report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.helpyousponsor.com/v1/admin/progress_report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.helpyousponsor.com/v1/admin/progress_report"
payload := strings.NewReader("{\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"hysform_id\": \"1\",\n \"program_id\": 1,\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"type\": \"donor\",\n \"client_id\": \"1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-HYS-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.helpyousponsor.com/v1/admin/progress_report")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"hysform_id\": \"1\",\n \"program_id\": 1,\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"type\": \"donor\",\n \"client_id\": \"1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/progress_report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date_from\": \"2022-01-01\",\n \"date_to\": \"2022-12-31\",\n \"hysform_id\": \"1\",\n \"program_id\": 1,\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"type\": \"donor\",\n \"client_id\": \"1\"\n}"
response = http.request(request)
puts response.read_body{
"fields": [
{}
],
"organization": {},
"forms": [
{}
],
"total": 100,
"profile_fields": [
{}
],
"date_from": "2022-01-01",
"date_to": "2022-12-31"
}{
"errors": {
"date_from": "The date from field is required."
}
}
