JSON PATH avatar

JSON PATH

Try for free

3 days trial then $10.00/month - No credit card required now

Go to Store
JSON PATH

JSON PATH

dtrungtin/jsonpath
Try for free

3 days trial then $10.00/month - No credit card required now

Analyse, transform, and selectively extract data from JSON documents (and JavaScript objects).

You can access the JSON PATH programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "0.0",
5    "x-build-id": "7reZ7p5iiYTmcg5yz"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/dtrungtin~jsonpath/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-dtrungtin-jsonpath",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/dtrungtin~jsonpath/runs": {
50      "post": {
51        "operationId": "runs-sync-dtrungtin-jsonpath",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/dtrungtin~jsonpath/run-sync": {
93      "post": {
94        "operationId": "run-sync-dtrungtin-jsonpath",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "url"
135        ],
136        "properties": {
137          "url": {
138            "title": "URL of the page",
139            "type": "string",
140            "description": "The URL of website you want to get the data from."
141          },
142          "jsonPath": {
143            "title": "Json Path",
144            "type": "string",
145            "description": "The json path to query."
146          },
147          "transformFunction": {
148            "title": "Transform function",
149            "type": "string",
150            "description": "Function that takes each item ($) as argument and returns data as output"
151          }
152        }
153      },
154      "runsResponseSchema": {
155        "type": "object",
156        "properties": {
157          "data": {
158            "type": "object",
159            "properties": {
160              "id": {
161                "type": "string"
162              },
163              "actId": {
164                "type": "string"
165              },
166              "userId": {
167                "type": "string"
168              },
169              "startedAt": {
170                "type": "string",
171                "format": "date-time",
172                "example": "2025-01-08T00:00:00.000Z"
173              },
174              "finishedAt": {
175                "type": "string",
176                "format": "date-time",
177                "example": "2025-01-08T00:00:00.000Z"
178              },
179              "status": {
180                "type": "string",
181                "example": "READY"
182              },
183              "meta": {
184                "type": "object",
185                "properties": {
186                  "origin": {
187                    "type": "string",
188                    "example": "API"
189                  },
190                  "userAgent": {
191                    "type": "string"
192                  }
193                }
194              },
195              "stats": {
196                "type": "object",
197                "properties": {
198                  "inputBodyLen": {
199                    "type": "integer",
200                    "example": 2000
201                  },
202                  "rebootCount": {
203                    "type": "integer",
204                    "example": 0
205                  },
206                  "restartCount": {
207                    "type": "integer",
208                    "example": 0
209                  },
210                  "resurrectCount": {
211                    "type": "integer",
212                    "example": 0
213                  },
214                  "computeUnits": {
215                    "type": "integer",
216                    "example": 0
217                  }
218                }
219              },
220              "options": {
221                "type": "object",
222                "properties": {
223                  "build": {
224                    "type": "string",
225                    "example": "latest"
226                  },
227                  "timeoutSecs": {
228                    "type": "integer",
229                    "example": 300
230                  },
231                  "memoryMbytes": {
232                    "type": "integer",
233                    "example": 1024
234                  },
235                  "diskMbytes": {
236                    "type": "integer",
237                    "example": 2048
238                  }
239                }
240              },
241              "buildId": {
242                "type": "string"
243              },
244              "defaultKeyValueStoreId": {
245                "type": "string"
246              },
247              "defaultDatasetId": {
248                "type": "string"
249              },
250              "defaultRequestQueueId": {
251                "type": "string"
252              },
253              "buildNumber": {
254                "type": "string",
255                "example": "1.0.0"
256              },
257              "containerUrl": {
258                "type": "string"
259              },
260              "usage": {
261                "type": "object",
262                "properties": {
263                  "ACTOR_COMPUTE_UNITS": {
264                    "type": "integer",
265                    "example": 0
266                  },
267                  "DATASET_READS": {
268                    "type": "integer",
269                    "example": 0
270                  },
271                  "DATASET_WRITES": {
272                    "type": "integer",
273                    "example": 0
274                  },
275                  "KEY_VALUE_STORE_READS": {
276                    "type": "integer",
277                    "example": 0
278                  },
279                  "KEY_VALUE_STORE_WRITES": {
280                    "type": "integer",
281                    "example": 1
282                  },
283                  "KEY_VALUE_STORE_LISTS": {
284                    "type": "integer",
285                    "example": 0
286                  },
287                  "REQUEST_QUEUE_READS": {
288                    "type": "integer",
289                    "example": 0
290                  },
291                  "REQUEST_QUEUE_WRITES": {
292                    "type": "integer",
293                    "example": 0
294                  },
295                  "DATA_TRANSFER_INTERNAL_GBYTES": {
296                    "type": "integer",
297                    "example": 0
298                  },
299                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
300                    "type": "integer",
301                    "example": 0
302                  },
303                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
304                    "type": "integer",
305                    "example": 0
306                  },
307                  "PROXY_SERPS": {
308                    "type": "integer",
309                    "example": 0
310                  }
311                }
312              },
313              "usageTotalUsd": {
314                "type": "number",
315                "example": 0.00005
316              },
317              "usageUsd": {
318                "type": "object",
319                "properties": {
320                  "ACTOR_COMPUTE_UNITS": {
321                    "type": "integer",
322                    "example": 0
323                  },
324                  "DATASET_READS": {
325                    "type": "integer",
326                    "example": 0
327                  },
328                  "DATASET_WRITES": {
329                    "type": "integer",
330                    "example": 0
331                  },
332                  "KEY_VALUE_STORE_READS": {
333                    "type": "integer",
334                    "example": 0
335                  },
336                  "KEY_VALUE_STORE_WRITES": {
337                    "type": "number",
338                    "example": 0.00005
339                  },
340                  "KEY_VALUE_STORE_LISTS": {
341                    "type": "integer",
342                    "example": 0
343                  },
344                  "REQUEST_QUEUE_READS": {
345                    "type": "integer",
346                    "example": 0
347                  },
348                  "REQUEST_QUEUE_WRITES": {
349                    "type": "integer",
350                    "example": 0
351                  },
352                  "DATA_TRANSFER_INTERNAL_GBYTES": {
353                    "type": "integer",
354                    "example": 0
355                  },
356                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
357                    "type": "integer",
358                    "example": 0
359                  },
360                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
361                    "type": "integer",
362                    "example": 0
363                  },
364                  "PROXY_SERPS": {
365                    "type": "integer",
366                    "example": 0
367                  }
368                }
369              }
370            }
371          }
372        }
373      }
374    }
375  }
376}

JSON PATH OpenAPI definition

OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.

OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.

By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.

You can download the OpenAPI definitions for JSON PATH from the options below:

If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.

You can also check out our other API clients:

Developer
Maintained by Community

Actor Metrics

  • 1 monthly user

  • 0 No bookmarks yet

  • >99% runs succeeded

  • Created in Oct 2024

  • Modified 4 months ago