---
title: Decoy REST API
description: Decoy application programming interface (API) provides information about the Internet Protocol (IP) address that accessed the decoy Uniform Resource Locator (URL) along with the method used to access the decoy URL.
component: pingintelligence
version: 5.2
page_id: pingintelligence:pingintelligence_reference_guide:pingintelligence_decoy_rest_api
canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/pingintelligence_reference_guide/pingintelligence_decoy_rest_api.html
revdate: April 3, 2024
---

# Decoy REST API

Decoy application programming interface (API) *(tooltip: \<div class="paragraph">
\<p>A specification of interactions available for building software to access an application or service.\</p>
\</div>)* provides information about the Internet Protocol (IP) *(tooltip: \<div class="paragraph">
\<p>The method by which data is sent across the internet from the source host to the destination host.\</p>
\</div>)* address that accessed the decoy Uniform Resource Locator (URL) *(tooltip: \<div class="paragraph">
\<p>Identifies a resource according to its internet location.\</p>
\</div>)* along with the method used to access the decoy URL.

It also reports about the type of device that was used to access the decoy URL.

`Method: GET`

`URL: /v4/abs/decoy?later_date<>&earlier_date<>`

|            | Header     | Value       |
| ---------- | ---------- | ----------- |
| Access Key | `x-abs-ak` | *\<string>* |
| Secret Key | `x-abs-sk` | *\<string>* |

Sample Response:

```json
{
 "company": "ping identity",
 "name": "decoy_api_metrics",
 "description": "This report contains detailed information on client access to each decoy API",
 "earlier_date": "Tue Jan 11 17:50:00:000 2018",
 "later_date": "Tue Jan 11 18:00:00:000 2018",
 "api_name": "atmapp",
 "api_type": "decoy-incontext",
 "decoy_url": [
 "/atmapp/decoy"
 ],
 "summary": [
 {
 "decoy_url": "/atmapp/decoy",
 "unique_ip_count": 122,
 "total_requests": 240,
 "most_used_methods": {
 "GET": 88,
 "DELETE": 32,
 "ABDU": 32,
 "POST": 30,
 "PUT": 26
 },
 "most_used_ips": {
 "100.64.9.37": 4,
 "100.64.10.79": 4,
 "100.64.31.183": 2,
 "100.64.20.213": 2,
 "100.64.34.239": 2
 },
 "most_used_devices": {
 "UBUNTU": 76,
 "MAC_OS_X": 69,
 "WINDOWS_7": 61,
 "WINDOWS_XP": 34
 },
 "most_used_content_types": {
 "UNKNOWN": 184,
 "multipart/form-data": 56
 }
 }
 ],
 "details": [
 {
 "decoy_url": "/atmapp/decoy",
 "source_ip": [
 {
 "ip": "100.64.31.183",
 "total_requests": 2,
 "method_count": {
 "GET": {
 "count": 2
 }
 },
 "url_count": {
 "/atmapp/decoy": 2
 }
 },
 {
 "ip": "100.64.14.28",
 "total_requests": 2,
 "method_count": {
 "POST": {
 "count": 2,
 "payload_characteristics": {
 "multipart/form-data": [
 "354 bytes"
 ]
 }
 }
 },
 "url_count": {
 "/atmapp/decoy": 2
 }
 },
 {
 "ip": "100.64.0.55",
 "total_requests": 2,
 "method_count": {
 "GET": {
 "count": 2
 }
 },
 "url_count": {
 "/atmapp/decoy": 2
 }
 },
 {
 "ip": "100.64.20.152",
 "total_requests": 2,
 "method_count": {
 "DELETE": {
 "count": 2
 }
 },
 "url_count": {
 "/atmapp/decoy": 2
 }
 }
 ]
 }
 ]
}
```