Retrieves a push including it’s payload and details. If the push is still active, this will burn a view and the transaction will be logged in the push audit log.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fk27vnslkd.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" --data "url[payload]=myurl&url[expire_after_days]=2&url[expire_after_views]=10" https://pwpush.com/r.json
Param name | Description |
---|---|
url
required |
Push details Validations:
|
url[payload]
required |
The URL encoded URL to redirect to. Validations:
|
url[passphrase]
optional |
Require recipients to enter this passphrase to view the created push. Validations:
|
url[note]
optional |
If authenticated, the URL encoded note for this push. Visible only to the push creator. Validations:
|
url[expire_after_days]
optional |
Expire secret link and delete after this many days. Validations:
|
url[expire_after_views]
optional |
Expire secret link and delete after this many views. Validations:
|
url[retrieval_step]
optional |
Helps to avoid chat systems and URL scanners from eating up views. Validations:
|
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fk27vnslkd/preview.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
This will return array of views including IP, referrer and other such metadata. The successful field indicates whether the view was made while the push was still active (and not expired). Note that you must be the owner of the push to retrieve the audit log and this call will always return 401 Unauthorized for pushes not owned by the credentials provided.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fk27vnslkd/audit.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Expires a push immediately. Must be authenticated & owner of the push or the push must have been created with deleteable_by_viewer.
curl -X DELETE -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/fkwjfvhall92.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Returns the list of URL pushes that you previously pushed which are still active.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/active.json
Returns the list of URL pushes that you previously pushed which have expired.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/r/expired.json