Report Action: Re-run Report

POST

https://withpersona.com/api/v1/reports/:report-id/run

POST

/api/v1/reports/:report-id/run

1 curl -X POST https://withpersona.com/api/v1/reports/report-id/run \
2      -H "Authorization: <apiKey>"

Try it

1 {
2   "data": {
3     "type": "report/watchlist",
4     "id": "rep_EPehAHkBaZKUxxxLEDL1gv4h",
5     "attributes": {
6       "status": "ready",
7       "created-at": "2022-01-14T23:42:01.000Z",
8       "completed-at": "2022-01-14T23:42:01.000Z",
9       "redacted-at": {},
10       "report-template-version-name": "v1",
11       "term": "Alexander Sample",
12       "matched_lists": []
13     },
14     "relationships": {
15       "inquiry": {
16         "data": {}
17       },
18       "account": {
19         "data": {}
20       },
21       "report-template": {
22         "data": {
23           "type": "report-template/watchlist",
24           "id": "rptp_jfp2TAY28vijxxxCcn4WVqdX"
25         }
26       }
27     }
28   }
29 }

Re-run a continuously monitored report immediately, outside of its existing recurrence schedule.

Path parameters

report-idstringRequired

Response

200

dataobject or null

Errors

200

Report Action: Re-run Report

Re-run a continuously monitored report immediately, outside of its existing recurrence schedule.

Report Action: Pause Continuous Monitoring

1	curl -X POST https://withpersona.com/api/v1/reports/report-id/run \
2	-H "Authorization: <apiKey>"

1	{
2	"data": {
3	"type": "report/watchlist",
4	"id": "rep_EPehAHkBaZKUxxxLEDL1gv4h",
5	"attributes": {
6	"status": "ready",
7	"created-at": "2022-01-14T23:42:01.000Z",
8	"completed-at": "2022-01-14T23:42:01.000Z",
9	"redacted-at": {},
10	"report-template-version-name": "v1",
11	"term": "Alexander Sample",
12	"matched_lists": []
13	},
14	"relationships": {
15	"inquiry": {
16	"data": {}
17	},
18	"account": {
19	"data": {}
20	},
21	"report-template": {
22	"data": {
23	"type": "report-template/watchlist",
24	"id": "rptp_jfp2TAY28vijxxxCcn4WVqdX"
25	}
26	}
27	}
28	}
29	}

Path parameters

Headers

Response

Errors