POST api/Zone/Redirection/Hit?user={user}

Get hits associated to a list of redirection handles

Request Information

URI Parameters

NameDescriptionTypeAdditional information
user

Optional user handle - if empty logged in user will be used

string

None.

Body Parameters

Object containing filter values

RedirectionHitFilter
NameDescriptionTypeAdditional information
From

Start date

date

None.

To

End date

date

None.

RedirectionHandles

List of redirection handles to return data for

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "From": "2024-07-10T00:41:48.7797152+02:00",
  "To": "2024-07-10T00:41:48.7797152+02:00",
  "RedirectionHandles": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<RedirectionHitFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
  <From>2024-07-10T00:41:48.7797152+02:00</From>
  <RedirectionHandles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RedirectionHandles>
  <To>2024-07-10T00:41:48.7797152+02:00</To>
</RedirectionHitFilter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RedirectionHitFilter'.

Response Information

Resource Description

Collection of RedirectionHitMulti
NameDescriptionTypeAdditional information
ZoneHandle

Zone handle

string

None.

RedirectionHandle

Redirection handle

string

None.

Number

Number of hits

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ZoneHandle": "sample string 1",
    "RedirectionHandle": "sample string 2",
    "Number": 3
  },
  {
    "ZoneHandle": "sample string 1",
    "RedirectionHandle": "sample string 2",
    "Number": 3
  }
]

application/xml, text/xml

Sample:
<ArrayOfRedirectionHitMulti xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Zone">
  <RedirectionHitMulti>
    <Number>3</Number>
    <RedirectionHandle>sample string 2</RedirectionHandle>
    <ZoneHandle>sample string 1</ZoneHandle>
  </RedirectionHitMulti>
  <RedirectionHitMulti>
    <Number>3</Number>
    <RedirectionHandle>sample string 2</RedirectionHandle>
    <ZoneHandle>sample string 1</ZoneHandle>
  </RedirectionHitMulti>
</ArrayOfRedirectionHitMulti>