GET v1/crawlevents

This returns a paginated list of all of the CrawlEvents for a specific Channel.

Request Information

Parameters

NameDescriptionAdditional information
start The start timestamp of the selection of crawl events to return.

Define this parameter in the request URI.

end The end timestamp of the selection of crawl events to return.

Define this parameter in the request URI.

channel_id The ID of the Channel from which to select crawl events.

Define this parameter in the request URI.

page_size The number of records to be returned in each set.

Define this parameter in the request URI.

offset The number of records from which to start selecting.

Define this parameter in the request URI.

since This attribute allows the selection to return records that were modified after this timestamp.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "crawlEvents": [
    {
      "id": 1,
      "channel": 2,
      "start": "2017-06-23T20:41:19.5121942-05:00",
      "length": 4,
      "text": "sample string 5",
      "deleted": true
    },
    {
      "id": 1,
      "channel": 2,
      "start": "2017-06-23T20:41:19.5121942-05:00",
      "length": 4,
      "text": "sample string 5",
      "deleted": true
    },
    {
      "id": 1,
      "channel": 2,
      "start": "2017-06-23T20:41:19.5121942-05:00",
      "length": 4,
      "text": "sample string 5",
      "deleted": true
    }
  ]
}

application/xml, text/xml

Sample:
<Resources xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CablecastAPI.DTOs">
  <CrawlEvents>
    <CrawlEvent>
      <Channel>2</Channel>
      <Deleted>true</Deleted>
      <Id>1</Id>
      <Length>4</Length>
      <Start>2017-06-23T20:41:19.5121942-05:00</Start>
      <Text>sample string 5</Text>
    </CrawlEvent>
    <CrawlEvent>
      <Channel>2</Channel>
      <Deleted>true</Deleted>
      <Id>1</Id>
      <Length>4</Length>
      <Start>2017-06-23T20:41:19.5121942-05:00</Start>
      <Text>sample string 5</Text>
    </CrawlEvent>
    <CrawlEvent>
      <Channel>2</Channel>
      <Deleted>true</Deleted>
      <Id>1</Id>
      <Length>4</Length>
      <Start>2017-06-23T20:41:19.5121942-05:00</Start>
      <Text>sample string 5</Text>
    </CrawlEvent>
  </CrawlEvents>
</Resources>