|
2531 | 2531 | "type": "string" |
2532 | 2532 | } |
2533 | 2533 | }, |
| 2534 | + { |
| 2535 | + "name": "filters", |
| 2536 | + "in": "query", |
| 2537 | + "description": "Filter based on feature properties. The input is of the form: key+op+type+value,key+op+type+value,... 'key' is a properties field key. 'op' is '>', '<', '=', or 'in'. If 'op' is 'in', 'value' is a list separated by dollar signs. 'type' is either 'string' or 'number'.", |
| 2538 | + "example": "passDirection+=+string+Ascending,fractionLand+<+number+0.10274648744404924", |
| 2539 | + "required": false, |
| 2540 | + "schema": { |
| 2541 | + "type": "string" |
| 2542 | + } |
| 2543 | + }, |
2534 | 2544 | { |
2535 | 2545 | "name": "limited", |
2536 | 2546 | "in": "query", |
|
2753 | 2763 | "type": "string" |
2754 | 2764 | } |
2755 | 2765 | }, |
| 2766 | + { |
| 2767 | + "name": "filters", |
| 2768 | + "in": "query", |
| 2769 | + "description": "Filter based on feature properties. The input is of the form: key+op+type+value,key+op+type+value,... 'key' is a properties field key. 'op' is '>', '<', '=', or 'in'. If 'op' is 'in', 'value' is a list separated by dollar-signs. 'type' is either 'string' or 'number'.", |
| 2770 | + "example": "passDirection+=+string+Ascending,fractionLand+<+number+0.10274648744404924", |
| 2771 | + "required": false, |
| 2772 | + "schema": { |
| 2773 | + "type": "string" |
| 2774 | + } |
| 2775 | + }, |
2756 | 2776 | { |
2757 | 2777 | "name": "limited", |
2758 | 2778 | "in": "query", |
|
2982 | 3002 | } |
2983 | 3003 | } |
2984 | 3004 | }, |
| 3005 | + "/api/geodatasets/aggregations": { |
| 3006 | + "get": { |
| 3007 | + "summary": "Return the histograms/aggregations of values for the feature properties within a GeoDataset.", |
| 3008 | + "tags": ["GeoDatasets"], |
| 3009 | + "parameters": [ |
| 3010 | + { |
| 3011 | + "name": "layer", |
| 3012 | + "in": "query", |
| 3013 | + "description": "The name of a GeoDataset for which to get aggregations.", |
| 3014 | + "example": "ExampleGeoDataset", |
| 3015 | + "required": true, |
| 3016 | + "schema": { |
| 3017 | + "type": "string" |
| 3018 | + } |
| 3019 | + }, |
| 3020 | + { |
| 3021 | + "name": "limit", |
| 3022 | + "in": "query", |
| 3023 | + "description": "Construct the aggregations based on a random sample of 'limit' features. Default 500", |
| 3024 | + "example": 100, |
| 3025 | + "required": false, |
| 3026 | + "schema": { |
| 3027 | + "type": "integer" |
| 3028 | + } |
| 3029 | + }, |
| 3030 | + { |
| 3031 | + "name": "minx", |
| 3032 | + "in": "query", |
| 3033 | + "description": "If only a certain spatial extent is desired, the minimum x/longitude of such bounding box.", |
| 3034 | + "example": -83.6, |
| 3035 | + "required": false, |
| 3036 | + "schema": { |
| 3037 | + "type": "number" |
| 3038 | + } |
| 3039 | + }, |
| 3040 | + { |
| 3041 | + "name": "miny", |
| 3042 | + "in": "query", |
| 3043 | + "description": "If only a certain spatial extent is desired, the minimum y/latitude of such bounding box.", |
| 3044 | + "example": -23.8, |
| 3045 | + "required": false, |
| 3046 | + "schema": { |
| 3047 | + "type": "number" |
| 3048 | + } |
| 3049 | + }, |
| 3050 | + { |
| 3051 | + "name": "maxx", |
| 3052 | + "in": "query", |
| 3053 | + "description": "If only a certain spatial extent is desired, the maximum x/longitude of such bounding box.", |
| 3054 | + "example": -32.6, |
| 3055 | + "required": false, |
| 3056 | + "schema": { |
| 3057 | + "type": "number" |
| 3058 | + } |
| 3059 | + }, |
| 3060 | + { |
| 3061 | + "name": "maxy", |
| 3062 | + "in": "query", |
| 3063 | + "description": "If only a certain spatial extent is desired, the maximum y/latitude of such bounding box.", |
| 3064 | + "example": 10.5, |
| 3065 | + "required": false, |
| 3066 | + "schema": { |
| 3067 | + "type": "number" |
| 3068 | + } |
| 3069 | + }, |
| 3070 | + { |
| 3071 | + "name": "starttime", |
| 3072 | + "in": "query", |
| 3073 | + "description": "If only a certain temporal extent is desired, the start time of the window. If unset but 'endtime' is set, defaults to '1970-01-01T00:00:00Z'", |
| 3074 | + "example": "2024-08-01T00:00:00.000Z", |
| 3075 | + "required": false, |
| 3076 | + "schema": { |
| 3077 | + "type": "string" |
| 3078 | + } |
| 3079 | + }, |
| 3080 | + { |
| 3081 | + "name": "endtime", |
| 3082 | + "in": "query", |
| 3083 | + "description": "If only a certain temporal extent is desired, the end time of the window.", |
| 3084 | + "example": "2025-04-03T21:55:06.013Z", |
| 3085 | + "required": false, |
| 3086 | + "schema": { |
| 3087 | + "type": "string" |
| 3088 | + } |
| 3089 | + } |
| 3090 | + ], |
| 3091 | + "responses": { |
| 3092 | + "200": { |
| 3093 | + "description": "GeoDataset aggregations", |
| 3094 | + "content": { |
| 3095 | + "application/json": { |
| 3096 | + "examples": { |
| 3097 | + "success": { |
| 3098 | + "summary": "Success", |
| 3099 | + "value": { |
| 3100 | + "status": "success", |
| 3101 | + "aggregations": [ |
| 3102 | + { |
| 3103 | + "passDirection": { |
| 3104 | + "type": "string", |
| 3105 | + "aggs": { "Descending": 252, "Ascending": 248 } |
| 3106 | + } |
| 3107 | + }, |
| 3108 | + { |
| 3109 | + "crossesDateline": { |
| 3110 | + "type": "boolean", |
| 3111 | + "aggs": { "true": 2, "false": 498 } |
| 3112 | + } |
| 3113 | + } |
| 3114 | + ] |
| 3115 | + } |
| 3116 | + }, |
| 3117 | + "failure": { |
| 3118 | + "summary": "Failure", |
| 3119 | + "value": { |
| 3120 | + "status": "failure", |
| 3121 | + "message": "Failure querying geodataset aggregations" |
| 3122 | + } |
| 3123 | + }, |
| 3124 | + "not_found": { |
| 3125 | + "summary": "Not Found", |
| 3126 | + "value": { |
| 3127 | + "status": "failure", |
| 3128 | + "message": "Not Found" |
| 3129 | + } |
| 3130 | + } |
| 3131 | + } |
| 3132 | + } |
| 3133 | + } |
| 3134 | + } |
| 3135 | + } |
| 3136 | + } |
| 3137 | + }, |
2985 | 3138 | "/api/geodatasets/append/{name}": { |
2986 | 3139 | "post": { |
2987 | 3140 | "summary": "Append to a geodataset", |
|
0 commit comments