GET api/keyword

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of keyword
NameDescriptionTypeAdditional information
SearchKeywordId

integer

None.

SiteId

integer

None.

Keyword

string

Data type: Text

URL

string

Data type: Text

Active

boolean

None.

Modified

date

Data type: DateTime

StartDt

date

Data type: DateTime

EndDt

date

Data type: DateTime

Response Formats

application/json, text/json

Sample:
[
  {
    "SearchKeywordId": 1,
    "SiteId": 2,
    "Keyword": "sample string 3",
    "URL": "sample string 4",
    "Active": true,
    "Modified": "2026-09-09T23:06:06.4312178+00:00",
    "StartDt": "2026-09-09T23:06:06.4312178+00:00",
    "EndDt": "2026-09-09T23:06:06.4312178+00:00"
  },
  {
    "SearchKeywordId": 1,
    "SiteId": 2,
    "Keyword": "sample string 3",
    "URL": "sample string 4",
    "Active": true,
    "Modified": "2026-09-09T23:06:06.4312178+00:00",
    "StartDt": "2026-09-09T23:06:06.4312178+00:00",
    "EndDt": "2026-09-09T23:06:06.4312178+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfkeyword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SIM.Model.Entities">
  <keyword>
    <Active>true</Active>
    <EndDt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-09T23:06:06.4312178Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDt>
    <Keyword>sample string 3</Keyword>
    <Modified xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-09T23:06:06.4312178Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Modified>
    <SearchKeywordId>1</SearchKeywordId>
    <SiteId>2</SiteId>
    <StartDt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-09T23:06:06.4312178Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDt>
    <URL>sample string 4</URL>
  </keyword>
  <keyword>
    <Active>true</Active>
    <EndDt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-09T23:06:06.4312178Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </EndDt>
    <Keyword>sample string 3</Keyword>
    <Modified xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-09T23:06:06.4312178Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Modified>
    <SearchKeywordId>1</SearchKeywordId>
    <SiteId>2</SiteId>
    <StartDt xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-09T23:06:06.4312178Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </StartDt>
    <URL>sample string 4</URL>
  </keyword>
</ArrayOfkeyword>