Skip to content

Updated the doc with new warning and usageDetails field #4956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Updated the doc with new warning and usageDetails field #4956

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a02abc
Updated the doc with new warning and usageDetails field
JV0812 Jan 13, 2025
7f21e87
Merge branch 'main' into update-search-job-api-doc
JV0812 Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions docs/api/search-job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ This is the formatted result document:

```json
{
"warning":"",
"state":"DONE GATHERING RESULTS",
"messageCount":90,
"histogramBuckets":[
Expand All @@ -356,7 +357,6 @@ This is the formatted result document:
"count":1,
"startTimestamp":1359405480000
},
...
{
"length":60000,
"count":1,
Expand All @@ -367,7 +367,10 @@ This is the formatted result document:
],
"pendingWarnings":[
],
"recordCount":1
"recordCount":1,
"usageDetails":{
"dataScannedInBytes":0
}
}
```

Expand All @@ -385,12 +388,16 @@ Notice that the state of the sample search job is DONE GATHERING RESULTS. The fo

#### More about results

The **warnings** value contains the detailed information about the warning while obtaining the current status of a search job.

The **messageCount** and **recordCount** values indicate the number of messages and records found or produced so far. Messages are raw log messages and records are aggregated data.

For queries that do not contain an aggregation operator, only messages are returned. If the query contains an aggregation, for example, **count by _sourceCategory**, then the messages are returned along with records resulting from the aggregation (similar to what a SQL database would return).

The **pendingErrors** and **pendingWarnings** values contain any pending error or warning strings that have accumulated since the last time the status was requested.

The **usageDetails** value contains the amount of data scanned in bytes details.

Errors and warnings are not cumulative. If you need to retain the errors and warnings, store them locally.

The **histogramBuckets** value returns a list of histogram buckets. A histogram bucket is defined by its timestamp, which is the start timestamp (in milliseconds) of the bucket, and a length, also in milliseconds, that expressed the width of the bucket. The **timestampplus** length is the end timestamp of the bucket, so the count is the number of messages in the bucket.
Expand Down Expand Up @@ -468,6 +475,7 @@ curl -b cookies.txt -c cookies.txt -H 'Accept: application/json'

```json
{
"warning": "",
"fields":[
{
"name":"_messageid",
Expand Down Expand Up @@ -595,6 +603,7 @@ curl -b cookies.txt -c cookies.txt -H 'Accept: application/json'

The result contains two lists, **fields** and **messages**.

* ***warnings** contains the detailed information about the warning while paging through the messages found by a search job.
* **fields** contains a list of all the fields defined for each of the messages returned. For each field, the field name and field type are returned.
* **messages** contains a list of maps, one map per message. Each **map** maps from the fields described in the fields list to the actual value for the message.

Expand Down Expand Up @@ -666,6 +675,7 @@ This is the formatted result document:

```json
{
"warning": "",
"fields":[
{
"name":"_sourceCategory",
Expand All @@ -691,6 +701,8 @@ This is the formatted result document:

The returned document is similar to the one returned for the message paging API. The schema of the records returned is described by the list of fields as part of the fields element. The records themselves are a list of maps.

The ***warnings** contains the detailed information about the warning while paging through the records found by a Search Job.

</details>

## POST Methods
Expand Down Expand Up @@ -828,10 +840,12 @@ Example error response:

```json
{
"status" : 400,
"id" : "IUUQI-DGH5I-TJ045",
"code" : "searchjob.invalid.timestamp.from",
"message" : "The 'from' field contains an invalid time."
"warning": "A 404 status (Page Not Found) on a follow-up request may be due to a cookie not accompanying the request",
"id": "IUUQI-DGH5I-TJ045",
"link": {
"rel": "self",
"href": "https://api.sumologic.com/api/v1/search/jobs/IUUQI-DGH5I-TJ045"
}
}
```

Expand Down
Loading