You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Regardless of whether you’re a dapp developer or a subgraph developer, you’ll need to manage your API keys.
6
+
This is important for you to be able to query subgraphs because API keys make sure the connections
7
+
between application services are valid and authorized. This includes authenticating the end user
8
+
and the device using the application.
9
+
10
+
The Studio will list out existing API keys, which will give you the ability to manage or delete them.
11
+
12
+
1. The **Overview** section will allow you to:
13
+
- Edit your key name
14
+
- Regenerate API keys
15
+
- View the current usage of the API key with stats:
16
+
- Number of queries
17
+
- Amount of GRT spent
18
+
2. Under **Security**, you’ll be able to opt into security settings depending on the level of control you’d like to have over your API keys. In this section, you can:
19
+
- View and manage the domain names authorized to use your API key
20
+
- Assign subgraphs that can be queried with your API key
21
+
3. Under **Indexer Preference**, you’ll be able to set different preferences for Indexers who are indexing subgraphs that your API key is used for. You can assign up to 5 points for each of these:
22
+
-**Fastest Speed**: Time between the query and the response from an indexer. If you mark this as important we will optimize for fast indexers.
23
+
-**Lowest Price**: The amount paid per query. If you mark this as important we will optimize for the less expensive indexers.
24
+
-**Data Freshness**: How recent the latest block an indexer has processed for the subgraph you are querying. If you mark this as important we will optimize to find the indexers with the freshest data.
25
+
-**Economic Security**: The amount of GRT an indexer can lose if they respond incorrectly to your query. If you mark this as important we will optimize for indexers with a large stake.
26
+
4. Under **Budget**, you’ll be able to update the maximum price per query. Note that we have a dynamic setting for that that's based on a volume discounting algorithm.
27
+
**We strongly recommend using the default settings unless you are experiencing a specific problem.**
28
+
Otherwise, you can update it under "Set a custom maximum budget". On this page you can also view different KPIs (in GRT and USD):
Copy file name to clipboardExpand all lines: pages/en/studio/subgraph-studio.mdx
+1-32Lines changed: 1 addition & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ The best part! When you first create a subgraph, you’ll be directed to fill ou
37
37
- Your Subgraph Name
38
38
- Image
39
39
- Description
40
-
- Categories
40
+
- Categories (e.g. `DeFi`, `NFTs`, `Governance`)
41
41
- Website
42
42
43
43
## Subgraph Compatibility with The Graph Network
@@ -98,34 +98,3 @@ Whenever you deploy a new subgraph version in the Subgraph Studio, the previous
98
98
99
99

100
100
101
-
## Managing your API Keys
102
-
103
-
Regardless of whether you’re a dapp developer or a subgraph developer, you’ll need to manage your API keys. This is important for you to be able to query subgraphs because API keys make sure the connections between application services are valid and authorized. This includes authenticating the end user and the device using the application.
104
-
105
-
The Studio will list out existing API keys, which will give you the ability to manage or delete them.
106
-
107
-
1. The **Overview** section will allow you to:
108
-
- Edit your key name
109
-
- Regenerate API keys
110
-
- View the current usage of the API key with stats:
111
-
- Number of queries
112
-
- Amount of GRT spent
113
-
2. Under **Security**, you’ll be able to opt into security settings depending on the level of control you’d like to have over your API keys. In this section, you can:
114
-
- View and manage the domain names authorized to use your API key
115
-
- Assign subgraphs that can be queried with your API key
116
-
3. Under **Indexer Preference**, you’ll be able to set different preferences for Indexers who are indexing subgraphs that your API key is used for. You can assign up to 5 points for each of these:
117
-
-**Fastest Speed**: Time between the query and the response from an indexer. If you mark this as important we will optimize for fast indexers.
118
-
-**Lowest Price**: The amount paid per query. If you mark this as important we will optimize for the less expensive indexers.
119
-
-**Data Freshness**: How recent the latest block an indexer has processed for the subgraph you are querying. If you mark this as important we will optimize to find the indexers with the freshest data.
120
-
-**Economic Security**: The amount of GRT an indexer can lose if they respond incorrectly to your query. If you mark this as important we will optimize for indexers with a large stake.
121
-
4. Under **Budget**, you’ll be able to update the maximum price per query. Note that we have a dynamic setting for that that's based on a volume discounting algorithm. **We strongly recommend using the default settings unless you are experiencing a specific problem.** Otherwise, you can update it under "Set a custom maximum budget". On this page you can also view different KPIs (in GRT and USD):
122
-
- Average cost per query
123
-
- Failed queries over max price
124
-
- Most expensive query
125
-
126
-
## How to Manage your Subgraph
127
-
128
-
API keys aside, you’ll have many tools at your disposal to manage your subgraphs. You can organize your subgraphs by their **status** and **category**.
129
-
130
-
- The **Status** tag allows you to pick between a variety of tags including `<created>`, `<deployed>`, `<published>`, `<archived>`, etc.
131
-
- Meanwhile, **Category** allows you to designate what category your subgraph falls into. Options include `<DeFi>`, `<NFTs>`, `<Governance>`, etc.
0 commit comments