Moz Knowledge Base/API Support Forums/Mozscape Developer Discussion Group

Available columns in the Linkscape Ruby gem and the Free API

Spectate
posted this on December 14, 2011 02:29 PM

I'm using the Linkscape gem (v0.3.2) to access your Free API.

Is there some documentation that maps the "Available Response Column" in the gem documentation with the URL metrics in the metrics API call? Some seem straight forward (e.g. I think :external_links = ueid or External Juice-Passing Links) but others (e.g. :juice_fq_domains_linking) are less intuitive.

 

Comments latest first

User photo
Carin Overturf
SEOmoz

Hey Spectate,

The response from the our engineer is:

Once you've loaded the gem, Linkscape::Constants::URLResponseFields[key][:desc] will give you the description.

I hope that helps!

Thanks,
Carin 

January 03, 2012 02:19 PM
User photo
Carin Overturf
SEOmoz

Hey again!

I'm not sure actually, but let me reach out to the engineers and see if they can answer that.


Thanks,
Carin 

January 02, 2012 07:53 PM
User photo
Spectate

One more question about this: the description fields in the constants file would be useful for my app - https://github.com/seomoz/linkscape-gem/blob/master/lib/linkscape/c.... Any way to access those programmatically either in the response or just using the client?

December 29, 2011 10:56 AM
User photo
Carin Overturf
SEOmoz

Thanks for posting that link Chastell! 

Glad to hear that helps clarify, Spectate :)

December 16, 2011 10:21 AM
User photo
Spectate

Thanks! That's exactly what I was looking for. Might be worth linking to that file from the README as that was the one missing piece for me. The rest of the documentation was very thorough.

December 16, 2011 06:13 AM
User photo
chastell

Spectate – note that you can check all of the mapping in https://github.com/seomoz/linkscape-gem/blob/master/lib/linkscape/constants.rb – you can see there that :fq_domain_fq_domains_linking is a ‘nice name’ for :fid (and verify other likewise).

December 16, 2011 03:07 AM
User photo
Carin Overturf
SEOmoz

I talked with our Linkscape Gem engineer and he had the following in response to your question:

So, the active resource version of the gem specifies the keys as well as "human names", but the :fq_domain_fq_somains_linking label matches with the "fid" column.

Hope that helps - let me know if you have questions on any other calls!

Thanks,
Carin

December 15, 2011 04:57 PM
User photo
Spectate

Sure, a good example is :fq_domain_fq_domains_linking. I don't know which URL metric that represents or even how I would go about matching that metric name to something here - http://apiwiki.seomoz.org/w/page/13991153/URL%20Metrics%20API. Is it something with the Response Field?

December 15, 2011 11:31 AM
User photo
Carin Overturf
SEOmoz

Hey! You can find the URL Metrics defined on the following pages in our API Wiki:

http://apiwiki.seomoz.org/w/page/13991153/URL%20Metrics%20API
http://apiwiki.seomoz.org/w/page/13991145/Request-Response%20Format

I know it's not very intuitive or straight forward :) We are actively working on some major improvements to the API Wiki, however. I'll make sure we incorporate this feedback into the improvements we are making!

In the meantime, are there specific calls you're having problems mapping? I could help point you in the right direction and it would also be good to know what calls are less intuitive to map.

Thanks!
Carin 

December 15, 2011 11:19 AM