\SearchAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
SearchAround	Get /api/{org_id}/{stream_name}/_around	SearchAround
SearchAroundV2	Post /api/{org_id}/{stream_name}/_around	SearchAroundV2
SearchHistory	Post /api/{org_id}/_search_history	Search History
SearchPartition	Post /api/{org_id}/_search_partition	SearchStreamPartition
SearchSQL	Post /api/{org_id}/_search	SearchStreamData
SearchValues	Get /api/{org_id}/{stream_name}/_values	SearchTopNValues

SearchAround

SearchResponse SearchAround(ctx, orgId, streamName).Key(key).Size(size).Regions(regions).Timeout(timeout).Execute()

SearchAround

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	streamName := "streamName_example" // string | stream_name name
	key := int64(789) // int64 | around key
	size := int64(789) // int64 | around size
	regions := "regions_example" // string | regions, split by comma (optional)
	timeout := int64(789) // int64 | timeout, seconds (optional)

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.SearchAround(context.Background(), orgId, streamName).Key(key).Size(size).Regions(regions).Timeout(timeout).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAround``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchAround`: SearchResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAround`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId	string	Organization name
streamName	string	stream_name name

Other Parameters

Other parameters are passed through a pointer to a apiSearchAroundRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

SearchResponse

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchAroundV2

SearchResponse SearchAroundV2(ctx, orgId, streamName).Size(size).Body(body).Regions(regions).Timeout(timeout).Execute()

SearchAroundV2

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	streamName := "streamName_example" // string | stream_name name
	size := int64(789) // int64 | around size
	body := "{"_timestamp":1675182660872049,"container_image":"dkr.ecr.us-west-2.amazonaws.com/openobserve:v0.0.3","container_name":"openobserve","docker_id":"eb0983bdb9ff9360d227e6a0b268fe3b24a0868c2c2d725a1516c11e88bf5789","host":"ip.us-east-2.compute.internal","namespace_name":"openobserve","pod_id":"35a0421f-9203-4d73-9663-9ff0ce26d409","pod_name":"openobserve-ingester-0"}" // string | around record data
	regions := "regions_example" // string | regions, split by comma (optional)
	timeout := int64(789) // int64 | timeout, seconds (optional)

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.SearchAroundV2(context.Background(), orgId, streamName).Size(size).Body(body).Regions(regions).Timeout(timeout).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchAroundV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchAroundV2`: SearchResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchAroundV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId	string	Organization name
streamName	string	stream_name name

Other Parameters

Other parameters are passed through a pointer to a apiSearchAroundV2Request struct via the builder pattern

Name	Type	Description	Notes

Return type

SearchResponse

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchHistory

SearchResponse SearchHistory(ctx, orgId).SearchHistoryRequest(searchHistoryRequest).Execute()

Search History

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization ID
	searchHistoryRequest := *openobserve.NewSearchHistoryRequest(int64(123), int64(123)) // SearchHistoryRequest | Search history request parameters

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.SearchHistory(context.Background(), orgId).SearchHistoryRequest(searchHistoryRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchHistory``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchHistory`: SearchResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchHistory`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId	string	Organization ID

Other Parameters

Other parameters are passed through a pointer to a apiSearchHistoryRequest struct via the builder pattern

Name	Type	Description	Notes

searchHistoryRequest | SearchHistoryRequest | Search history request parameters |

Return type

SearchResponse

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchPartition

SearchResponse SearchPartition(ctx, orgId).SearchRequest(searchRequest).Execute()

SearchStreamPartition

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	searchRequest := *openobserve.NewSearchRequest(*openobserve.NewSearchQuery("Sql_example")) // SearchRequest | Search query

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.SearchPartition(context.Background(), orgId).SearchRequest(searchRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchPartition``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchPartition`: SearchResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchPartition`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId	string	Organization name

Other Parameters

Other parameters are passed through a pointer to a apiSearchPartitionRequest struct via the builder pattern

Name	Type	Description	Notes

searchRequest | SearchRequest | Search query |

Return type

SearchResponse

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchSQL

SearchResponse SearchSQL(ctx, orgId).SearchRequest(searchRequest).Execute()

SearchStreamData

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	searchRequest := *openobserve.NewSearchRequest(*openobserve.NewSearchQuery("Sql_example")) // SearchRequest | Search query

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.SearchSQL(context.Background(), orgId).SearchRequest(searchRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchSQL``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchSQL`: SearchResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchSQL`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId	string	Organization name

Other Parameters

Other parameters are passed through a pointer to a apiSearchSQLRequest struct via the builder pattern

Name	Type	Description	Notes

searchRequest | SearchRequest | Search query |

Return type

SearchResponse

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchValues

SearchResponse SearchValues(ctx, orgId, streamName).Fields(fields).Size(size).StartTime(startTime).EndTime(endTime).Filter(filter).Keyword(keyword).Regions(regions).Timeout(timeout).NoCount(noCount).Execute()

SearchTopNValues

Example

package main

import (
	"context"
	"fmt"
	"os"
	openobserve "github.com/rachzy/sdk-go-openobserve"
)

func main() {
	orgId := "orgId_example" // string | Organization name
	streamName := "streamName_example" // string | stream_name name
	fields := "fields_example" // string | fields, split by comma
	size := int64(789) // int64 | size
	startTime := int64(789) // int64 | start time
	endTime := int64(789) // int64 | end time
	filter := "filter_example" // string | filter, eg: a=b (optional)
	keyword := "keyword_example" // string | keyword, eg: abc (optional)
	regions := "regions_example" // string | regions, split by comma (optional)
	timeout := int64(789) // int64 | timeout, seconds (optional)
	noCount := true // bool | no need count, true of false (optional)

	configuration := openobserve.NewConfiguration()
	apiClient := openobserve.NewAPIClient(configuration)
	resp, r, err := apiClient.SearchAPI.SearchValues(context.Background(), orgId, streamName).Fields(fields).Size(size).StartTime(startTime).EndTime(endTime).Filter(filter).Keyword(keyword).Regions(regions).Timeout(timeout).NoCount(noCount).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SearchAPI.SearchValues``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SearchValues`: SearchResponse
	fmt.Fprintf(os.Stdout, "Response from `SearchAPI.SearchValues`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
orgId	string	Organization name
streamName	string	stream_name name

Other Parameters

Other parameters are passed through a pointer to a apiSearchValuesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

SearchResponse

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SearchAPI.md

Latest commit

History

SearchAPI.md

File metadata and controls

\SearchAPI

SearchAround

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchAroundV2

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchHistory

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchPartition

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchSQL

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchValues

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers