Salt Edge Endpoints

Statistics

These endpoints are responsible for fetching the API Availability and Performance statistics of the Production environment of an ASPSP.
It is recommended to be used in the case that the ASPSP runs a job on their side to automatically fetch statistics and complete the Quarterly Report required by the National Regulator.
Available only for live connectors.
The same statistics can be downloaded manually from the ASPSP Dashboard.

Availability New

Returns the list of Availability reports per each day.
Default period: last 30 days. Has limit: one request per hour.

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7Imxhc3RfcXVhcnRlciI6ZmFsc2UsInN0YXJ0X2RhdGUiOiIyMDI0LTA1LTAxIiwiZW5kX2RhdGUiOiIyMDI0LTA1LTMwIn0sImV4cCI6MTczMjQ1MDY0MiwiaXNzIjoicHJpb3JhLnNhbHRlZGdlLmNvbSJ9.DNK8NWpc-bXNIvaDGaToioBF12axR4jLHBTGNOMNb406GhVxlYO2QvdDBQuOw3Kamkojk0co8_UyHrxiIpFsdvF4auurbEfLfX56BFu8QsDhqyOpyh1qulC4uw1PFUv4X8un3IlrjulhO1-WuPX40Xob25CINSr7emxrFr4r8-UFMtZ8SYlMOQgHZfT0dso9G4yIx-5G_fincEj9dK1Z4p5TAnWDCsmzR90Ygr_hoLvYglTSuIWU-Cvz-OkSecAi7UFMRkjKdYDRnFWL7XNLbE8wTA0EN1ZcSWodni9Q5PlM8iimsEimcStm1fxvT-jUrRshscI5K_HMOc26Hg6L2Q" \ -H "App-Id: G9SgwyF-RdxsjCu3f3mLnw" \ -H "App-Secret: Az6qAhT6pdezVjAex58qqQ" \ -X GET "/api/connectors/ob/v1/statistics/availability"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7Imxhc3RfcXVhcnRlciI6ZmFsc2UsInN0YXJ0X2RhdGUiOiIyMDI0LTA1LTAxIiwiZW5kX2RhdGUiOiIyMDI0LTA1LTMwIn0sImV4cCI6MTczMjQ1MDY0MiwiaXNzIjoicHJpb3JhLnNhbHRlZGdlLmNvbSJ9.DNK8NWpc-bXNIvaDGaToioBF12axR4jLHBTGNOMNb406GhVxlYO2QvdDBQuOw3Kamkojk0co8_UyHrxiIpFsdvF4auurbEfLfX56BFu8QsDhqyOpyh1qulC4uw1PFUv4X8un3IlrjulhO1-WuPX40Xob25CINSr7emxrFr4r8-UFMtZ8SYlMOQgHZfT0dso9G4yIx-5G_fincEj9dK1Z4p5TAnWDCsmzR90Ygr_hoLvYglTSuIWU-Cvz-OkSecAi7UFMRkjKdYDRnFWL7XNLbE8wTA0EN1ZcSWodni9Q5PlM8iimsEimcStm1fxvT-jUrRshscI5K_HMOc26Hg6L2Q" \ 
 -H "App-Id: G9SgwyF-RdxsjCu3f3mLnw" \ 
 -H "App-Secret: Az6qAhT6pdezVjAex58qqQ" \ 
 -X GET "/api/connectors/ob/v1/statistics/availability"

Example of request parameters

{"data":{"last_quarter":false,"start_date":"2024-05-01","end_date":"2024-05-30"},"exp":1721987394}

Example of response

{"data":[{"date":"2024-07-26","availability":"90.00%","downtime":"8640.0s"}]}

Request

GET /api/connectors/ob/v1/statistics/availability

Headers

Header	Type	Description
`Content-Type`	string, required	The media type of the body of the request. Allowed values: application/jwt, text/plain
`App-Id`	string, required	Provider's `app_id` from connection details tab. Can raise: ProviderNotFound, ProviderDisabled, ConfigurationError
`App-Secret`	string, required	Provider's `app_secret` from connection details tab.

Unpacked Request Body (JWT)

data

hash, required

Wrapper for the data.

last_quarter

boolean, optional

Indicates to return report for the last 3 months. Can be overridden by start_date &end_date params.

start_date

date, optional

Start date of the report. Should be in past or today, not after end_date. (Format: YYYY-MM-DD)

end_date

date, optional

End date of the report. Should be in past or today. (Format: YYYY-MM-DD)

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

array, required

Wrapper for the data.

date

date, required

Date of report. (Format: YYYY-MM-DD)

availability

string, required

The measure of how often the service was available to clients (%).

downtime

string, required

The amount of time that the service was unavailable (seconds).

Related Errors

Class	Code	Description
ConfigurationError	400	Missing configurations in dashboard.
ProviderNotFound	404	Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled	406	Cooperation with specified Provider is impossible.

API Performance New

Returns the list of Performance statistics reports per each day.
If kind is not specified, a summary report will be returned. Otherwise, a detailed report will be returned.
Default period: last 30 days. Has limit: one request per hour.

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImtpbmQiOlsiYWlzcCIsInBpc3AiLCJwaWlzcCIsIm90aGVyIl0sImxhc3RfcXVhcnRlciI6ZmFsc2UsInN0YXJ0X2RhdGUiOiIyMDI0LTA2LTAxIiwiZW5kX2RhdGUiOiIyMDI0LTA2LTMwIn0sImV4cCI6MTczMjQ1MDY0MywiaXNzIjoicHJpb3JhLnNhbHRlZGdlLmNvbSJ9.qhIzp3OxfxyzovT_xdonNV12PtnMZnCktOEWg2Aov5MjO2YzmdSFI97ujurZdoNqyCHoY3S-YKbts--E476ebipG3omrbs1e6kk--lU2gydipuuXRkDy8apw5U1NHFRMAOFlBP_OxdIm8dpuVd-KOv4z0d0bO-5BqsNUxU0EU1V3FzzSM84KdH0ZycWTooYEG9mZyke_J9BsAWI5rSSeekitMBdWrMVM4pTGldio7LOBsdCdKMv5Y5mVevTeZROKc2QWSuE_sakWBe6Lwyo_PJpjsc-Jb4gZoQyw_b-fsQq_wYKZRCyRkNVYpM1sHP2DSjG9JDeEURTpJClmAgATQw" \ -H "App-Id: G9SgwyF-RdxsjCu3f3mLnw" \ -H "App-Secret: Az6qAhT6pdezVjAex58qqQ" \ -X GET "/api/connectors/ob/v1/statistics/api_performance"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImtpbmQiOlsiYWlzcCIsInBpc3AiLCJwaWlzcCIsIm90aGVyIl0sImxhc3RfcXVhcnRlciI6ZmFsc2UsInN0YXJ0X2RhdGUiOiIyMDI0LTA2LTAxIiwiZW5kX2RhdGUiOiIyMDI0LTA2LTMwIn0sImV4cCI6MTczMjQ1MDY0MywiaXNzIjoicHJpb3JhLnNhbHRlZGdlLmNvbSJ9.qhIzp3OxfxyzovT_xdonNV12PtnMZnCktOEWg2Aov5MjO2YzmdSFI97ujurZdoNqyCHoY3S-YKbts--E476ebipG3omrbs1e6kk--lU2gydipuuXRkDy8apw5U1NHFRMAOFlBP_OxdIm8dpuVd-KOv4z0d0bO-5BqsNUxU0EU1V3FzzSM84KdH0ZycWTooYEG9mZyke_J9BsAWI5rSSeekitMBdWrMVM4pTGldio7LOBsdCdKMv5Y5mVevTeZROKc2QWSuE_sakWBe6Lwyo_PJpjsc-Jb4gZoQyw_b-fsQq_wYKZRCyRkNVYpM1sHP2DSjG9JDeEURTpJClmAgATQw" \ 
 -H "App-Id: G9SgwyF-RdxsjCu3f3mLnw" \ 
 -H "App-Secret: Az6qAhT6pdezVjAex58qqQ" \ 
 -X GET "/api/connectors/ob/v1/statistics/api_performance"

Example of request parameters

{"data":{"kind":["aisp","pisp","piisp","other"],"last_quarter":false,"start_date":"2024-06-01","end_date":"2024-06-30"},"exp":1721987394}

Example of response

{"data":[{"date":"2024-07-29","kind":"pisp","requests":7,"failed_requests":1,"invalid_requests":1,"successful_requests":5,"average_execution_time":100.0,"error_response_rate":14.28}]}

Request

GET /api/connectors/ob/v1/statistics/api_performance

Headers

Header	Type	Description
`Content-Type`	string, required	The media type of the body of the request. Allowed values: application/jwt, text/plain
`App-Id`	string, required	Provider's `app_id` from connection details tab. Can raise: ProviderNotFound, ProviderDisabled, ConfigurationError
`App-Secret`	string, required	Provider's `app_secret` from connection details tab.

Unpacked Request Body (JWT)

data

hash, required

Wrapper for the data.

kind

array, optional

Type of request. If not specified, summary report will be returned. Allowed values: aisp, pisp, piisp, other

last_quarter

boolean, optional

Indicates to return report for the last 3 months. Can be overridden by start_date &end_date params.

start_date

date, optional

Start date of the report. Should be in past or today, not after end_date. (Format: YYYY-MM-DD)

end_date

date, optional

End date of the report. Should be in past or today. (Format: YYYY-MM-DD)

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

array, required

Wrapper for the data.

date

date, required

Date of report. (Format: YYYY-MM-DD)

kind

string, required

Kind of token.

requests

integer, required

The count of all requests.

failed_requests

integer, required

The count of failed requests (5xx).

invalid_requests

integer, required

The count of invalid requests (4xx).

successful_requests

integer, required

The count of successful requests (2xx).

average_execution_time

float, required

The average request processing time from clients (milliseconds).

error_response_rate

float, required

The measure of how often the service responded with an error to clients (%).

Related Errors

Class	Code	Description
ConfigurationError	400	Missing configurations in dashboard.
ProviderNotFound	404	Provider specified in request does not exist or cannot be retrieved.
ProviderDisabled	406	Cooperation with specified Provider is impossible.